Ctrl+K

CommentStyles Class Reference

CommentStyles Class Reference#

Demo: doxysphinx::doxygen::CommentStyles Class Reference
Demo
Public Member Functions |List of all members
doxysphinx::doxygen::CommentStyles Class Referenceabstract
Demonstration of doxygen comment style usage. See also 

Comment Syntax Documentation

. More...

#include <comment_styles.hpp>

Public Member Functions

void ensure_javadoc_style_comments_are_working_as_expected () const =0
 
void ensure_javadoc_style_comments_with_identation_are_working_as_expected () const =0
 
void ensure_javadoc_style_without_stars_are_working_as_expected () const =0
 
void ensure_qt_style_comments_are_working_as_expected () const =0
 
void ensure_qt_style_comments_with_identation_are_working_as_expected () const =0
 
void ensure_qt_style_without_stars_are_working_as_expected () const =0
 
void ensure_slash_style_comments_are_working_as_expected () const =0
 
void ensure_slash_style_comments_with_asterisk_are_working_as_expected () const =0
 
void ensure_slash_style_comments_with_identation_are_working_as_expected () const =0
 
void ensure_slash_style_with_exclamations_are_working_as_expected () const =0
 

Detailed Description

Demonstration of doxygen comment style usage. See also 

Comment Syntax Documentation

.

Member Function Documentation

◆ ensure_javadoc_style_comments_are_working_as_expected()

void doxysphinx::doxygen::CommentStyles::ensure_javadoc_style_comments_are_working_as_expected ( ) const
pure virtual

What you should see here

This text should be in an admonition box. It was generated from a doxygen javadoc comment without any special identation.

Note that we had to add a space between the backslash and the verbatim command in the code because doxygen parsing will freak out if we add the command there…

/**
 * \ verbatim embed:rst
 *
 * ...rst-content-here...
 *
 * \ endverbatim
 *\/
 void ensure_javadoc_style_comments_are_working_as_expected() const = 0;

◆ ensure_javadoc_style_comments_with_identation_are_working_as_expected()

void doxysphinx::doxygen::CommentStyles::ensure_javadoc_style_comments_with_identation_are_working_as_expected ( ) const
pure virtual

What you should see here

This text should be in an admonition box. It was generated from a doxygen javadoc comment with the rst content indented.

Note that we had to add a space between the backslash and the verbatim command in the code because doxygen parsing will freak out if we add the command there…

/**
 * \ verbatim embed:rst
 *
 *     ...rst-content-here...
 *
 * \ endverbatim
 *\/
 void ensure_javadoc_style_comments_with_identation_are_working_as_expected() const = 0;

◆ ensure_javadoc_style_without_stars_are_working_as_expected()

void doxysphinx::doxygen::CommentStyles::ensure_javadoc_style_without_stars_are_working_as_expected ( ) const
pure virtual

What you should see here

This text should be in an admonition box. It was generated from a doxygen javadoc comment without any special identation.

Note that we had to add a space between the backslash and the verbatim command in the code because doxygen parsing will freak out if we add the command there…

/**
 \ verbatim embed:rst

  ...rst-content-here...

 \ endverbatim
 *\/
 void ensure_javadoc_style_without_stars_are_working_as_expected() const = 0;

◆ ensure_qt_style_comments_are_working_as_expected()

void doxysphinx::doxygen::CommentStyles::ensure_qt_style_comments_are_working_as_expected ( ) const
pure virtual

What you should see here

This text should be in an admonition box. It was generated from a doxygen qt comment without any special identation.

Note that we had to add a space between the backslash and the verbatim command in the code because doxygen parsing will freak out if we add the command there…

/*!
 * \ verbatim embed:rst
 *
 * ...rst-content-here...
 *
 * \ endverbatim
 *\/
 void ensure_qt_style_comments_are_working_as_expected() const = 0;

◆ ensure_qt_style_comments_with_identation_are_working_as_expected()

void doxysphinx::doxygen::CommentStyles::ensure_qt_style_comments_with_identation_are_working_as_expected ( ) const
pure virtual

What you should see here

This text should be in an admonition box. It was generated from a doxygen qt comment with the rst content indented.

Note that we had to add a space between the backslash and the verbatim command in the code because doxygen parsing will freak out if we add the command there…

/*!
 * \ verbatim embed:rst
 *
 *     ...rst-content-here...
 *
 * \ endverbatim
 *\/
 void ensure_qt_style_comments_with_identation_are_working_as_expected() const = 0;

◆ ensure_qt_style_without_stars_are_working_as_expected()

void doxysphinx::doxygen::CommentStyles::ensure_qt_style_without_stars_are_working_as_expected ( ) const
pure virtual

What you should see here

This text should be in an admonition box. It was generated from a doxygen qt comment without any special identation.

Note that we had to add a space between the backslash and the verbatim command in the code because doxygen parsing will freak out if we add the command there…

/*!
 \ verbatim embed:rst

  ...rst-content-here...

 \ endverbatim
 *\/
 void ensure_qt_style_without_stars_are_working_as_expected() const = 0;

◆ ensure_slash_style_comments_are_working_as_expected()

void doxysphinx::doxygen::CommentStyles::ensure_slash_style_comments_are_working_as_expected ( ) const
pure virtual

What you should see here

This text should be in an admonition box. It was generated from a doxygen slash comment without any special identation.

Note that we had to add a space between the backslash and the verbatim command in the code because doxygen parsing will freak out if we add the command there…

/// \ verbatim embed:rst
///
/// ...rst-content-here...
///
/// \ endverbatim
void ensure_slash_style_comments_are_working_as_expected() const = 0;

◆ ensure_slash_style_comments_with_asterisk_are_working_as_expected()

void doxysphinx::doxygen::CommentStyles::ensure_slash_style_comments_with_asterisk_are_working_as_expected ( ) const
pure virtual

What you should see here

This text should be in an admonition box. It was generated from a doxygen slash comment without any special identation but with asterisk embed command.

Note that we had to add a space between the backslash and the verbatim command in the code because doxygen parsing will freak out if we add the command there…

/// \ verbatim embed:rst:leading-asterisk
///
/// ...rst-content-here...
///
/// \ endverbatim
void ensure_slash_style_comments_with_asterisk_are_working_as_expected() const = 0;

◆ ensure_slash_style_comments_with_identation_are_working_as_expected()

void doxysphinx::doxygen::CommentStyles::ensure_slash_style_comments_with_identation_are_working_as_expected ( ) const
pure virtual

What you should see here

This text should be in an admonition box. It was generated from a doxygen slash comment with the rst content indented.

Note that we had to add a space between the backslash and the verbatim command in the code because doxygen parsing will freak out if we add the command there…

///
/// \ verbatim embed:rst
///
///     ...rst-content-here...
///
/// \ endverbatim
///
void ensure_slash_style_comments_with_identation_are_working_as_expected() const = 0;

◆ ensure_slash_style_with_exclamations_are_working_as_expected()

void doxysphinx::doxygen::CommentStyles::ensure_slash_style_with_exclamations_are_working_as_expected ( ) const
pure virtual

What you should see here

This text should be in an admonition box. It was generated from a doxygen slash comment with exclamationmarks instead of the third slash.

Note that we had to add a space between the backslash and the verbatim command in the code because doxygen parsing will freak out if we add the command there…

//! \ verbatim embed:rst
//!
//!  ...rst-content-here...
//!
//! \ endverbatim
void ensure_slash_style_with_exclamations_are_working_as_expected() const = 0;
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1