Looking for doxygen Answers? Try Ask4KnowledgeBase
Looking for doxygen Keywords? Try Ask4Keywords

doxygendoxygenを使い始める


備考

このセクションでは、doxygenの概要と、開発者がそれを使いたい理由について概説します。

それはまた、doxygen内の任意の大きな科目に言及し、関連トピックにリンクする必要があります。 doxygenのドキュメンテーションは新しいものなので、それらの関連トピックの初期バージョンを作成する必要があります。

コードのコメント

コメントブロックを詳細な説明としてマークするにはいくつかの方法があります。このコメントブロックはDoxygenによって解析され、次のコード項目の説明としてドキュメントに追加されます。最初の、最も一般的なものは、Cスタイルのコメントで、コメントの開始順序に余分なアスタリスクが付いています。例:

/**
 * … text …
 */
int dummy_var;
 

次の代替案は、Qtスタイルを使用し、Cスタイルのコメントブロックの開始シーケンスの後に感嘆符(!)を追加することです。

/*!
 * … text …
 */
void foo(void);
 

3番目の選択肢は、少なくとも2つのC ++コメント行のブロックを使用することです。各行はスラッシュまたは感嘆符で始まります。

/// 
/// ... text ... 
///
 

または

//! 
//! ... text ... 
//!
 

一部の人々は、コメントブロックをドキュメントでより目立たせたいと思っています。この目的のために、以下を使用することができます:

 /********************************************//** 
  * ... text 
  ***********************************************/
 

2つのスラッシュに注意して、通常のコメントブロックを終了し、特別なコメントブロックを開始してください。

/////////////////////////////////////////////////
/// ... text ...
/////////////////////////////////////////////////
 

生成されたドキュメントを構造化して作成するために、Doxygenは大きな数(> 170)の特殊コマンドを提供します。ドキュメントのすべてのコマンドは、バックスラッシュ()またはアットマーク(@)で始まります。

例えば

/**
 * \brief    A brief description in one short sentence.
 */
 

/**
 * @brief    A brief description in one short sentence.
 */
 

簡単な説明のために、いくつかの可能性があります。

\brief コマンドは、上記のコメントブロックのいずれかと一緒に使用できます。このコマンドは段落の終わりで終了するので、空の行の後に詳細な説明が続きます。

/** \brief Brief description. 
 * Brief description continued. 
 * 
 * Detailed description starts here. 
 */ 
 

設定ファイルでJAVADOC_AUTOBRIEFYES に設定されている場合、JavaDocスタイルのコメントブロックを使用すると、最初のドットで終わるスペースまたは改行で終了する簡単な説明が自動的に開始されます。

/// Brief description which ends at this dot. Details follow 
/// here. 
 

最後に、doxygenを使った関数の完全なドキュメントの例です:

/**
 * \brief   The function bar. 
 *
 * \details This function does something which is doing nothing. So this text
 *          is totally senseless and you really do not need to read this,
 *          because this text is basically saying nothing.
 *
 * \note    This text shall only show you, how such a \"note\" section
 *          is looking. There is nothing which really needs your notice,
 *          so you do not really need to read this section.
 *
 * \param[in]     a    Description of parameter a.
 * \param[out]    b    Description of the parameter b.
 * \param[in,out] c    Description of the parameter c.
 *
 * \return        The error return code of the function.
 *
 * \retval        ERR_SUCCESS    The function is successfully executed
 * \retval        ERR_FAILURE    An error occurred
 */

errcode_t bar(int a, int b, int c)
{    
    /** More detailed description inside the code */
}
 

ソースとDoxygenホームページの詳細

インストールまたはセットアップ

doxygenの設定またはインストールに関する詳細な手順。