Memo/Doxygen
をテンプレートにして作成
[
トップ
] [
新規
|
一覧
|
検索
|
最終更新
|
ヘルプ
|
ログイン
]
開始行:
#contents
*Doxygen [#m7f1c9b5]
-[[ドキュメント>http://www.doxygen.jp/config.html]]
&attachref(doxygen1.7.2.jpg,zoom,320x240);
**設定 [#y6edf5ec]
-&attachref(doxygen.config.1.7.2);
**インストール [#a58e1768]
-CentOS5.5 最新バイナリをインストール
#geshi(bash){{
sudo yum install graphviz --enablerepo=rpmforge
wget http://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.2....
tar xvfz doxygen-1.7.2.linux.bin.tar.gz
sudo cp doxygen-1.7.2/bin/* /usr/bin/
}}
-CentOS5.5 rpmはv1.4.7と古い
#geshi(bash){{
sudo yum install doxygen graphviz --enablerepo=rpmforge
}}
**ドキュメント [#n432e2c9]
-[[Doxygen>http://www.doxygen.jp/manual.html]]
**tips [#z535c020]
***文字コード変換 [#vcf38cad]
-[[nkf for windows>http://www.vector.co.jp/soft/win95/uti...
INPUT_FILTER "nkf -We"
**よく使うコメント表記 [#s04d22d3]
***基本 [#c0a92ffa]
-設定ファイルの「JAVADOC_AUTOBRIEF = YES」でJavaDoc形式に...
-設定ファイルの「JAVADOC_AUTOBRIEF = YES」で@briefを書か...
-''/** */''でDoxygenがコメントとして取り込む
-簡易形式は''///''
-''///<''で変数の後ろなどに、説明文を書ける
$var = '1'; ///< $varの説明文
-コメント中で改行するときは、''<br>''か''\n''を使う。
-表紙を作りたい場合は、@mainpage を使う。ただし、これは1...
-「@ref リンク先」で、セクション、サブセクション、ページ...
***トップページを変えたい場合 [#bc899a6e]
/** @mainpage My Personal Index Page
*
*
* @section intro Introduction
*
* This is the introduction.
*
* @section install Installation
*
* @subsection step1 Step 1: Opening the box
* etc...
*/
***ファイルの先頭 [#p23ec3cd]
/** @file
* @brief ファイルの簡単な説明
*
* briefだけで足りない場合はここにも説明を加える
*
* @attention 注意すべきテキスト
* @note 注釈のテキスト
* @sa ここを見て
*
* @author 作者名
* @date 200*/*/*
* @version バージョン番号
* $Revision: 57 $ (svnを使う場合、ここにリビジョン情報が...
*/
***クラス [#sc7667a1]
/**
* @brief クラスの簡易説明
* このクラスの使用目的・使用方法など詳しい情報を書く。
*
* @example testfilename.cpp (このクラスをテストするコー...
* @todo 必要であれば記述(リスト化される)
* @bug バグがあれば記述(リスト化される)
* @warning 警告
*/
class hoge
{
private:
/// メンバの説明
int foo;
protected:
/// ここも説明
int bar;
public:
/// クラスコンストラクタ
hoge ();
/// クラスデストラクタ
~hoge ();
//! 何かを取得する
bool get ( int nget );
};
***関数 [#x65043f7]
/**
* @brief 関数の簡易説明
* 関数の詳細な説明
*
*
* @param パラメータ名 パラメータの説明(各パラメータごと...
* @param パラメータ名 パラメータの説明(各パラメータごと...
* @param パラメータ名 パラメータの説明(各パラメータごと...
*
* @retval 返り値 返り値の説明
*/
double wedget ::get ( int input)
{
...;
}
/////////////////////////////////////////////////////////...
**FAQ [#cde1e58f]
***ツリービューが文字化けする [#e22a1e6c]
以下のオプションを付けると、ツリービューが作成されますが...
GENERATE_TREEVIEW = YES
ソースを見たところ、''tree.html''のヘッダにミスがあるよう...
charset=直後のダブルクォーテーションを削除すれば直ります。~
×:<meta http-equiv="Content-Type" content="text/xhtml;c...
○:<meta http-equiv="Content-Type" content="text/xhtml;c...
終了行:
#contents
*Doxygen [#m7f1c9b5]
-[[ドキュメント>http://www.doxygen.jp/config.html]]
&attachref(doxygen1.7.2.jpg,zoom,320x240);
**設定 [#y6edf5ec]
-&attachref(doxygen.config.1.7.2);
**インストール [#a58e1768]
-CentOS5.5 最新バイナリをインストール
#geshi(bash){{
sudo yum install graphviz --enablerepo=rpmforge
wget http://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.2....
tar xvfz doxygen-1.7.2.linux.bin.tar.gz
sudo cp doxygen-1.7.2/bin/* /usr/bin/
}}
-CentOS5.5 rpmはv1.4.7と古い
#geshi(bash){{
sudo yum install doxygen graphviz --enablerepo=rpmforge
}}
**ドキュメント [#n432e2c9]
-[[Doxygen>http://www.doxygen.jp/manual.html]]
**tips [#z535c020]
***文字コード変換 [#vcf38cad]
-[[nkf for windows>http://www.vector.co.jp/soft/win95/uti...
INPUT_FILTER "nkf -We"
**よく使うコメント表記 [#s04d22d3]
***基本 [#c0a92ffa]
-設定ファイルの「JAVADOC_AUTOBRIEF = YES」でJavaDoc形式に...
-設定ファイルの「JAVADOC_AUTOBRIEF = YES」で@briefを書か...
-''/** */''でDoxygenがコメントとして取り込む
-簡易形式は''///''
-''///<''で変数の後ろなどに、説明文を書ける
$var = '1'; ///< $varの説明文
-コメント中で改行するときは、''<br>''か''\n''を使う。
-表紙を作りたい場合は、@mainpage を使う。ただし、これは1...
-「@ref リンク先」で、セクション、サブセクション、ページ...
***トップページを変えたい場合 [#bc899a6e]
/** @mainpage My Personal Index Page
*
*
* @section intro Introduction
*
* This is the introduction.
*
* @section install Installation
*
* @subsection step1 Step 1: Opening the box
* etc...
*/
***ファイルの先頭 [#p23ec3cd]
/** @file
* @brief ファイルの簡単な説明
*
* briefだけで足りない場合はここにも説明を加える
*
* @attention 注意すべきテキスト
* @note 注釈のテキスト
* @sa ここを見て
*
* @author 作者名
* @date 200*/*/*
* @version バージョン番号
* $Revision: 57 $ (svnを使う場合、ここにリビジョン情報が...
*/
***クラス [#sc7667a1]
/**
* @brief クラスの簡易説明
* このクラスの使用目的・使用方法など詳しい情報を書く。
*
* @example testfilename.cpp (このクラスをテストするコー...
* @todo 必要であれば記述(リスト化される)
* @bug バグがあれば記述(リスト化される)
* @warning 警告
*/
class hoge
{
private:
/// メンバの説明
int foo;
protected:
/// ここも説明
int bar;
public:
/// クラスコンストラクタ
hoge ();
/// クラスデストラクタ
~hoge ();
//! 何かを取得する
bool get ( int nget );
};
***関数 [#x65043f7]
/**
* @brief 関数の簡易説明
* 関数の詳細な説明
*
*
* @param パラメータ名 パラメータの説明(各パラメータごと...
* @param パラメータ名 パラメータの説明(各パラメータごと...
* @param パラメータ名 パラメータの説明(各パラメータごと...
*
* @retval 返り値 返り値の説明
*/
double wedget ::get ( int input)
{
...;
}
/////////////////////////////////////////////////////////...
**FAQ [#cde1e58f]
***ツリービューが文字化けする [#e22a1e6c]
以下のオプションを付けると、ツリービューが作成されますが...
GENERATE_TREEVIEW = YES
ソースを見たところ、''tree.html''のヘッダにミスがあるよう...
charset=直後のダブルクォーテーションを削除すれば直ります。~
×:<meta http-equiv="Content-Type" content="text/xhtml;c...
○:<meta http-equiv="Content-Type" content="text/xhtml;c...
ページ名: