...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
Table 44.8. Syntax Compendium
To do this... |
Use this... |
See this... |
---|---|---|
comment |
|
|
italics |
|
|
bold |
|
|
underline |
|
|
|
|
|
strikethrough |
|
|
|
|
|
source mode |
|
|
inline code |
|
|
code block |
|
|
code escape |
|
|
line break |
|
line-break DEPRECATED |
anchor |
|
|
link |
|
|
anchor link |
|
|
refentry link |
|
|
function link |
|
function, class, member, enum, macro, concept or header links |
class link |
|
function, class, member, enum, macro, concept or header links |
member link |
|
function, class, member, enum, macro, concept or header links |
enum link |
|
function, class, member, enum, macro, concept or header links |
macro link |
|
function, class, member, enum, macro, concept or header links |
concept link |
|
function, class, member, enum, macro, concept or header links |
header link |
|
function, class, member, enum, macro, concept or header links |
global link |
|
function, class, member, enum, macro, concept or header links |
escape |
|
|
single char escape |
|
|
images |
|
|
begin section |
|
|
end section |
|
|
paragraph |
No markup. Paragraphs start left-flushed and are terminated by two or more newlines. |
|
ordered list |
# one # two # three |
|
unordered list |
* one * two * three |
|
code |
No markup. Preformatted code starts with a space or a tab. |
|
preformatted |
|
|
block quote |
|
|
heading 1 |
|
|
heading 2 |
|
|
heading 3 |
|
|
heading 4 |
|
|
heading 5 |
|
|
heading 6 |
|
|
macro |
|
|
template |
|
|
blurb |
|
|
admonition |
|
|
table |
[table Title [[a][b][c]] [[a][b][c]] ] |
|
variablelist |
[variablelist Title [[a][b]] [[a][b]] ] |
|
include |
|
|
conditional generation |
|