% doxygen -g
% vi Doxyfile
GENERATE_LATEX = NO
% doxygen
doxygenの場合色々な書き方のスタイルがありますが、自分なりに統一した方がよいでしょう。
私の場合は、メンバー変数は、header fileのクラス定義に、メソッドは、cpp fileの実体定義の前に
書いています。(クラス定義が太ると見通しがわるくなるので)
/**
* \brief 要約説明.
*
* 詳細説明.(前に空白行)
*/
class Foo : public Bar {
public:
int m_nBaz; //!< メンバー変数説明.(<をつけることで、後ろ側にかけます)
public:
Foo();
virtual ~Foo();
int multiply(int n);
};
/**
* \param n Integer to multiply.
* \return Result.
*/
int Foo::multiply(int n){
return m_nBaz * n;
}
ツール(T) -> スニペットの管理
ショートカット登録対象のファイルを選んで(例えばC++)。新規登録のアイコンを選択。
登録名を入れて、タブに「method」右側のテキストエリアにはこんな感じで登録しておく。
/**
* \brief A method to $1.
* \param $2
* \return $3
*/
$0
cpp拡張子を持つファイルで、"method"と入力してタブを押せば、上記doxygen用の定形文が入力され
$1にカーソルが移動します。同様にmember用の短文を
ちょっと便利だと思いますよ。
1. Open Synaptic Package Manager
3. Go to "Custom Filters", "Marked Changes"
4. Select all the packages except "doxygen", right-click and "Unmark"
5. Click "Apply"
lacheck latex-beamer lmodern pgf prosper texlive-latex-base-doc texlive-latex-extra-doc texlive-latex-recommended-doc texlive-luatex texlive-pictures-doc
https://bugs.launchpad.net/ubuntu/+source/doxygen/+bug/846314
検索キーワード "doxygen class メンバー"