InlineRst Class Reference#
| Demo |
doxysphinx::doxygen::InlineRst Class Reference
Demonstration of inline rst usage. See also
Rst Inline Syntax Documentation
. More...#include <inline_rst.hpp>
Public Member Functions | |
| void | inline_rst_syntax_in_comments () |
| shows how to use inline rst roles in doxygen comments More... | |
| void | inline_rst_syntax_in_lists () |
| shows how to use inline rst roles in doxygen list comments More... | |
| void | inline_rst_syntax_in_tables () |
| shows how to use inline rst roles in doxygen list comments More... | |
Detailed Description
Demonstration of inline rst usage. See also
.
Member Function Documentation
◆ inline_rst_syntax_in_comments()
| void doxysphinx::doxygen::InlineRst::inline_rst_syntax_in_comments | ( | ) |
shows how to use inline rst roles in doxygen comments
syntax
use this syntax in your doxygen comments (we left out the comment prefix [///, //! etc.] here).
1) A html code element with quotes like this - <code>:doc:"This is an inline link to the Main Documentation <index>"</code> - should work.
2) A html code element with ticks like this - <code>:doc:'This is an inline link to the Main Documentation <index>'</code> - should work.
3) A html code element with escaped backticks like this - <code>:doc:\`This is an inline link to the Main Documentation <index>\`</code> - should work.
4) A tt element with quotes like this - <tt>:doc:"This is an inline link to the Main Documentation <index>"</tt> - should work.
5) A tt element with ticks like this - <tt>:doc:'This is an inline link to the Main Documentation <index>'</tt> - should work.
6) A tt element with escaped backticks like this - <tt>:doc:\`This is an inline link to the Main Documentation <index>\`</tt> - should work.
7) A markdown inline statement with quotes like this - `:doc:"This is an inline link to the Main Documentation <index>"` - should work.
<em>Not working</em>:
8!) A markdown inline statement with ticks like this - `:doc:'This is an inline link to the Main Documentation <index>'` - won't work because
doxygen generates <code>‘</code> and <code>’</code> symbols instead of \em code-tags in this case (which is strange btw...).
9!) Escaping backticks in markdown inline statement - `:doc:\`This is an inline link to the Main Documentation <index>\`` - won't work because
doxygen preprocesses that in a strange way.
visual example
1) A html code element with quotes like this -
- should work.
2) A html code element with ticks like this -
- should work.
3) A html code element with escaped backticks like this -
- should work.
4) A tt element with quotes like this -
- should work.
5) A tt element with ticks like this -
- should work.
6) A tt element with escaped backticks like this -
- should work.
7) A markdown inline statement with quotes like this -
- should work.
Not working
8!) A markdown inline statement with ticks like this - ‘:doc:'This is an inline link to the Main Documentation <index>’` - won't work because doxygen generates ‘ and ’ symbols instead of code-tags in this case (which is strange btw...).
9!) Escaping backticks in markdown inline statement - :doc:\This is an inline link to the Main Documentation <index>`` - won't work because doxygen preprocesses that in a strange way.
◆ inline_rst_syntax_in_lists()
| void doxysphinx::doxygen::InlineRst::inline_rst_syntax_in_lists | ( | ) |
shows how to use inline rst roles in doxygen list comments
syntax
use this syntax in your doxygen comments (we left out the comment prefix [///, //! etc.] here).
1. A html code element with quotes like this - <code>:doc:"This is an inline link to the Main Documentation <index>"</code> - should work.
2. A html code element with ticks like this - <code>:doc:'This is an inline link to the Main Documentation <index>"</code> - should work.
3. A html code element with escaped backticks like this - <code>:doc:\`This is an inline link to the Main Documentation <index>\`</code> - should work.
4. A tt element with quotes like this - <tt>:doc:"This is an inline link to the Main Documentation <index>"</tt> - should work.
5. A tt element with ticks like this - <tt>:doc:'This is an inline link to the Main Documentation <index>'</tt> - should work.
6. A tt element with escaped backticks like this - <tt>:doc:\`This is an inline link to the Main Documentation <index>\`</tt> - should work.
7. A markdown inline statement with quotes like this - `:doc:"This is an inline link to the Main Documentation <index>"` - should work.
visual example
- A html code element with quotes like this - - should work.
- A html code element with ticks like this - - should work.
- A html code element with escaped backticks like this - - should work.
- A tt element with quotes like this - - should work.
- A tt element with ticks like this - - should work.
- A tt element with escaped backticks like this - - should work.
- A markdown inline statement with quotes like this - - should work.
◆ inline_rst_syntax_in_tables()
| void doxysphinx::doxygen::InlineRst::inline_rst_syntax_in_tables | ( | ) |
shows how to use inline rst roles in doxygen list comments
syntax
use this syntax in your doxygen comments (we left out the comment prefix [///, //! etc.] here).
markdown table:
First Header | Second Header
------------- | -----------------------------------
Content Cell | `:doc:"Main Documentation <index>"`
Content Cell | Content Cell
html table:
<table>
<tr><th>First Header</th><th>Second Header></th></tr>
<tr><td>Content Cell</td><td>`:doc:"Main Documentation <index>"`</td></tr>
<tr><td>Content Cell</td><td>Content Cell</td></tr>
</table>
visual example
markdown table:
| First Header | Second Header |
|---|---|
| Content Cell | |
| Content Cell | Content Cell |
html table:
| First Header | Second Header |
|---|---|
| Content Cell | |
| Content Cell | Content Cell |
The documentation for this class was generated from the following file:
- demo/demo/src/inline_rst.hpp
Generated by
1.9.1