Skip to content
Open
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
3 changes: 3 additions & 0 deletions .github/workflows/ci-utility-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ jobs:
- name: Check bootstrap options partial is up to date
run: python3 ./utils/docs/generate_bootstrap_options.py --check

- name: Check the commands registry and the Doxygen page against the parser
run: python3 ./utils/docs/check_commands_registry.py

# When the Coverage matrix entry was skipped because the develop cache is
# warm, fetch develop's LCOV report and re-upload it tagged with the PR's
# commit SHA. Codecov sees zero patch lines and unchanged project totals,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@
},
"auto-brief": {
"default": true,
"description": "When set to `true`, Mr.Docs uses the first line (until the first dot, question mark, or exclamation mark) of the comment as the brief of the symbol. When set to `false`, a explicit @brief command is required.",
"description": "When set to `true`, Mr.Docs uses the first paragraph of the comment as the brief of the symbol. When set to `false`, only the `@brief`, `@short`, `@copybrief`, and `@copydoc` commands set a brief.",
"enum": [
true,
false
],
"title": "Use the first line of the comment as the brief",
"title": "Use the first paragraph of the comment as the brief",
"type": "boolean"
},
"auto-function-metadata": {
Expand Down
1 change: 1 addition & 0 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
** xref:commands/metadata.adoc[Metadata Commands]
** xref:commands/inlines.adoc[Inline Commands]
** xref:commands/reference.adoc[Reference]
** xref:commands/doxygen.adoc[Doxygen Compatibility]
* Configuration
** xref:configuration/index.adoc[Overview]
** xref:configuration/inputs.adoc[Inputs]
Expand Down
Loading
Loading