Skip to content

Commit 42ba51e

Browse files
committed
docs: remove incorrect list from commands table
1 parent 35e14c9 commit 42ba51e

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/modules/ROOT/pages/commands.adoc

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -40,21 +40,22 @@ static constexpr int hours_in_day = 24;
4040
Both the class and the function above have doc comments with a brief sentence and a detailed description.
4141
Most doc comments will contain these two sections, which could also be explicitly marked with `@brief` and `@details` commands.
4242
43-
Doc comments can also contain a number of special commands such as `@param` that are used to document the parameters of a function.
44-
45-
== Style
46-
47-
The following commands can be used to format the text in the doc comments:
48-
49-
|===
50-
| Command | Description
51-
| `@a` | Formats the text in italics
52-
| `@e` | Formats the text in italics
53-
| `@em` | Formats the text in italics
54-
| `@b` | Formats the text in bold
55-
| `@strong` | Formats the text in bold
56-
|
57-
|===
43+
Doc comments can also contain many special commands, such as `@param`, that are used to document the parameters of a function.
44+
Mr. Docs supports most commands commonly used in Javadoc and Doxygen comments.
45+
46+
// == Style
47+
//
48+
// The following commands can be used to format the text in the doc comments:
49+
//
50+
// |===
51+
// | Command | Description
52+
// | `@a` | Formats the text in italics
53+
// | `@e` | Formats the text in italics
54+
// | `@em` | Formats the text in italics
55+
// | `@b` | Formats the text in bold
56+
// | `@strong` | Formats the text in bold
57+
// |
58+
// |===
5859
5960
// == Documentation at other places
6061
// @class, @struct, @union, @enum, @fn, @var, @def, @typedef, @file, @namespace...
@@ -96,4 +97,3 @@ The following commands can be used to format the text in the doc comments:
9697
// (<className>"::")n<functionName>
9798
// === Links to external documentation
9899
// Tagfiles + @ref
99-

0 commit comments

Comments
 (0)