Doxygen

doxygen1.7.2.jpg

設定

インストール

ドキュメント

tips

文字コード変換

よく使うコメント表記

基本

トップページを変えたい場合

	/** @mainpage My Personal Index Page
	 *
	 * 
	 * @section intro Introduction
	 *
	 * This is the introduction.
	 *
	 * @section install Installation
	 *
	 * @subsection step1 Step 1: Opening the box
	 * etc...
	 */

ファイルの先頭

	/** @file
	* @brief ファイルの簡単な説明 
	* 
	* briefだけで足りない場合はここにも説明を加える
	*
	* @attention 注意すべきテキスト
	* @note 注釈のテキスト
	* @sa ここを見て
	*
	* @author 作者名
	* @date 200*/*/*
	* @version バージョン番号
	* $Revision: 57 $ (svnを使う場合、ここにリビジョン情報が入る)
	*/

クラス

	/**
	* @brief クラスの簡易説明
	* このクラスの使用目的・使用方法など詳しい情報を書く。
	*
	* @example testfilename.cpp (このクラスをテストするコードを指定できる)
	* @todo 必要であれば記述(リスト化される)
	* @bug バグがあれば記述(リスト化される)
	* @warning 警告
	*/
	class hoge
	{
		private:
		/// メンバの説明
		int foo;
		protected:
		/// ここも説明
		int bar;
		public:
		/// クラスコンストラクタ
		hoge ();
		/// クラスデストラクタ
		~hoge ();
		//! 何かを取得する
		bool get ( int nget );
	};

関数

	/**
	* @brief 関数の簡易説明
	* 関数の詳細な説明
	*
	*
	* @param パラメータ名 パラメータの説明(各パラメータごとに@paramで分けて書く)
	* @param パラメータ名 パラメータの説明(各パラメータごとに@paramで分けて書く)
	* @param パラメータ名 パラメータの説明(各パラメータごとに@paramで分けて書く)
	*
	* @retval 返り値 返り値の説明
	*/
	double wedget ::get ( int input)
	{
	...;
	}

FAQ

ツリービューが文字化けする

以下のオプションを付けると、ツリービューが作成されますが、日本語が文字化けしている時があります。(Version 1.3.8 で確認)

GENERATE_TREEVIEW      = YES

ソースを見たところ、tree.htmlのヘッダにミスがあるようです。
charset=直後のダブルクォーテーションを削除すれば直ります。

×:<meta http-equiv="Content-Type" content="text/xhtml;charset="euc-jp" />
○:<meta http-equiv="Content-Type" content="text/xhtml;charset=euc-jp" />

添付ファイル: filedoxygen1.7.2.jpg 1740件 [詳細] filedoxygen.config.1.7.2 2116件 [詳細]

トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2018-09-15 (土) 07:31:37