BlockRst Class Reference

BlockRst Class Reference#

Demo: doxysphinx::doxygen::BlockRst Class Reference
Demo
Public Member Functions |List of all members
doxysphinx::doxygen::BlockRst Class Reference
Demonstration of block rst usage. See also 

Rst Block Syntax Documentation

. More...

#include <block_rst.hpp>

Public Member Functions

void block_rst_via_markdown ()
 RestructuredText block with markdown fences. More...
 
void block_rst_via_verbatim ()
 RestructuredText block doxygen verbatim special command. More...
 
void block_rst_via_code ()
 RestructuredText block doxygen code special command. More...
 
void block_rst_via_pre ()
 RestructuredText block with html pre tag in doxygen. More...
 

Detailed Description

Demonstration of block rst usage. See also 

Rst Block Syntax Documentation

.

Member Function Documentation

◆ block_rst_via_code()

void doxysphinx::doxygen::BlockRst::block_rst_via_code ( )

RestructuredText block doxygen code special command.

code command

Syntax

/// \code
/// {rst}
/// .. tip::
///
/// If you see a tip around this text it worked!
/// \endcode

Example

Tip

If you see a tip around this text it worked!

code command (breathe compatibility)

Syntax

/// @code embed:rst:leading-slashes
/// .. tip::
///
/// If you see a tip around this text it worked!
/// @code

Example

Tip

If you see a tip around this text it worked!

autodetecting directives

Syntax

/// \code
/// .. tip::
///
/// If you see a tip around this text it worked!
/// \endcode

Example

Tip

If you see a tip around this text it worked!

◆ block_rst_via_markdown()

void doxysphinx::doxygen::BlockRst::block_rst_via_markdown ( )

RestructuredText block with markdown fences.

standard fences

Syntax

/// ```
/// {rst}
/// .. tip::
///
/// If you see a tip around this text it worked!
/// ```

Example

Tip

If you see a tip around this text it worked!

special fences

Syntax

/// ~~~~~~~~~~~~~~~~
/// {rst}
/// .. tip::
///
/// If you see a tip around this text it worked!
/// ~~~~~~~~~~~~~~~~

Example

Tip

If you see a tip around this text it worked!

autodetecting directives

Syntax

/// ```
/// .. tip::
///
/// If you see a tip around this text it worked!
/// ```

Example

Tip

If you see a tip around this text it worked!

◆ block_rst_via_pre()

void doxysphinx::doxygen::BlockRst::block_rst_via_pre ( )

RestructuredText block with html pre tag in doxygen.

<pre>-html-element

Syntax

/// <pre> {rst}
/// .. tip::
///
/// If you see a tip around this text it worked!
/// </pre>

Example

Tip

If you see a tip around this text it worked!

autodetecting directives

Syntax

/// <pre>
/// .. tip::
///
/// If you see a tip around this text it worked!
/// </pre>

Example

Tip

If you see a tip around this text it worked!

◆ block_rst_via_verbatim()

void doxysphinx::doxygen::BlockRst::block_rst_via_verbatim ( )

RestructuredText block doxygen verbatim special command.

verbatim command

Syntax

/// \verbatim {rst}
/// .. tip::
///
/// If you see a tip around this text it worked!
/// \endverbatim

Example

Tip

If you see a tip around this text it worked!

verbatim command (breathe compatibility)

Syntax

/// @verbatim embed:rst:leading-slashes
/// .. tip::
///
/// If you see a tip around this text it worked!
/// @endverbatim

Example

Tip

If you see a tip around this text it worked!

autodetecting directives

Syntax

/// \verbatim
/// .. tip::
///
/// If you see a tip around this text it worked!
/// \endverbatim

Example

Tip

If you see a tip around this text it worked!

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1