Skip to content

Commit 9ece9df

Browse files
committed
auto-brief option
#feat
1 parent 1853739 commit 9ece9df

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

docs/mrdocs.schema.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,16 @@
1717
"title": "Extraction policy for anonymous namespaces",
1818
"type": "boolean"
1919
},
20+
"auto-brief": {
21+
"default": true,
22+
"description": "When set to `true`, MrDocs 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.",
23+
"enum": [
24+
true,
25+
false
26+
],
27+
"title": "Use the first line of the comment as the brief",
28+
"type": "boolean"
29+
},
2030
"base-url": {
2131
"default": "",
2232
"description": "Base URL for links to source code. The base URL is used to create links to the source code in the documentation. The base URL is combined with the path to the source file to create the link.",

src/lib/Lib/ConfigOptions.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,13 @@
253253
"details": "When set to `true`, relational operators are sorted last in the list of members of a record or namespace.",
254254
"type": "bool",
255255
"default": true
256+
},
257+
{
258+
"name": "auto-brief",
259+
"brief": "Use the first line of the comment as the brief",
260+
"details": "When set to `true`, MrDocs 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.",
261+
"type": "bool",
262+
"default": true
256263
}
257264
]
258265
},

0 commit comments

Comments
 (0)