Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document category options #16

Merged
merged 2 commits into from
Jul 26, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions _guides/arguments.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,38 @@ $ typedoc --externalPattern <pattern>

Define a pattern for files that should be considered being external.

### categorizeByGroup

```bash
$ typedoc --categorizeByGroup=false
```

This flag categorizes reflections by group (within properties, methods, etc).
To allow methods and properties of the same category to be grouped together, set this flag to false.
Defaults to true

### defaultCategory

```bash
$ typedoc --defaultCategory="Category Name"
```

Sets the name for the default category (which is used when some elements of the page are categorized).
Defaults to 'Other'

### categoryOrder

```json
{
"categoryOrder": ["Category Name", "Other Category", "*"]
}
```

Array option (available via json configuration) which allows overriding the order categories display in. A string of `*` indicates where categories that are not in the list should appear.

By default, categories are displayed alphabetically. If unknown categories are found, they will be listed at the end by default.


### gaID

```bash
Expand Down
10 changes: 9 additions & 1 deletion _guides/doccomments.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,16 @@ Keeps the subsequent code from being documented.
function doSomething(target: any, value: number): number;
```

### ```@category```
Allows grouping reflections on a page


```
/**
* Regular description
*
* @category Category Name
*/
funtion doSomething() {}

## Namespaces

Expand Down
3 changes: 3 additions & 0 deletions _includes/help_output.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ Usage:
typedoc --mode modules --out path/to/documentation path/to/sourcefiles

TypeDoc options:
--categorizeByGroup Specifies whether categorization will be done at the group level.
--categoryOrder Specifies the order in which categories appear. * indicates the relative order for categories not in the list.
--defaultCategory Specifies the default category for reflections without a category.
--disableOutputCheck Should TypeDoc disable the testing and cleaning of the output directory?
--entryPoint Specifies the fully qualified name of the root symbol. Defaults to global namespace.
--exclude Define patterns for excluded files when specifying paths.
Expand Down