DoxygenコードブロックでDoxygenを使用することを示す

Question

Doxygenを使用して特定のコンテキストでDoxygenを使用するためのベストプラクティスを示す文書を作成しています。

私はいくつかのドキュメントを持っているには、次の形式を取ります。 （私はDoxygenのの値下げ拡張子を使用していますことに注意してください）

Best practices for documenting 
============================== 

Do it like this: 

    /** 
    * @defgroup my_new_group My first Doxygen Group 
    * 
    * a brief desc. 
    */ 
    ... 

何が起こることは値下げ前プロセッサはDoxygenのがマークダウンする前に最初のコマンドを処理していることですプロセッサが動作します。

Doxygenを使用したDoxygenの使用例を示すオプションはありますか？

Answer 1

私は質問を正確に理解していません。

いずれにしても、ドキュメント自体でdoxygenコマンドを使用するには、これらをエスケープする必要があります。

いずれにそのまま出力ブロックに@verbatim xxx @endverbatimを使用するか、それがどのようにdefineグループを指定Doxygenのマニュアルでは\@

Answer 2

でコマンドをdoxygenを脱出した後、どのように定義されたグループに追加する：

To define a group, you should put the \defgroup command in a special 
comment block. The first argument of the command is a label that should 
uniquely identify the group. The second argument is the name or title of 
the group as it should appear in the documentation. (allowing you to use 
lower-case as the initial group name) 

したがって、次のようにグループを定義する必要があります。

/** Group Defines 
* @\defgroup foobar foobar 
*/ 

およびコードを通して、あなたは以下のようなものを使用することができますすること...など、機能を追加する：

/** 
* @addtogroup foobar 
* @{ 
*  (some documentation elements...) 
* @} 
*/