Doxygenを使ってみる(2)
前回はDoxygenをインストールしました。今回は実際のソースからドキュメントを生成します。
Doxygenでドキュメントを作成
Doxygenの実行について
インストーラでインストールした場合、GUIのウイザードもインストールされます。 ウイザードを使用すれば設定ファイルの生成からドキュメントの生成まで行うことができますが、 ここでは、コマンドラインを使用してドキュメントを作成します。
ウイザードでも基本的操作は変わりません。 設定ファイルを作成・保存し、doxygenを実行するのをGUI上で行うようになっています。
ソースにコメントをつける
doxygen ではQtタイプとJavadocタイプのコメントがサポートされています。
Qtタイプ例
/*! コメント */
Javadocタイプ例
/** * コメント */
ここではJavadocタイプのコメントからドキュメントを生成します。
サンプルとして以下のような2つのクラスのヘッダファイルにJavadoc風にコメントを記載します。
Person.h
#ifndef _PERSON_H_
#define _PERSON_H_
#include <string>
using namespace std;
/**
* 個人を表すクラスです。
* @author freepg-lab
* @version 1.0, 2005/12/04
*/
class Person
{
/** 名前 */
string name;
/** 年齢 */
int age;
public:
/**
* コンストラクタ。
*/
Person();
/**
* デストラクタ。
*/
virtual ~Person();
/**
* 名前を取得します。
* @return 名前
*/
string getName() const;
/**
* 名前を設定します。
* @param _name 名前
*/
void setName(const string& _name);
/**
* 年齢を取得します。
* @return 年齢
*/
int getAge() const;
/**
* 年齢を設定します。
* @param _age 年齢
*/
void setAge(int _age);
};
#endif //_PERSON_H_
Member.h
#ifndef _MEMBER_H_
#define _MEMBER_H_
#include <string>
#include "Person.h"
using namespace std;
/**
* 会員を表すクラスです。
* @author freepg-lab
* @version 1.0, 2005/12/04
*/
class Member : public Person
{
/** 会員ID */
string id;
public:
/**
* コンストラクタ。
*/
Member();
/**
* デストラクタ。
*/
virtual ~Member();
/**
* 会員IDを取得します。
* @return 会員ID
*/
string getId() const;
/**
* 会員IDを設定します。
*/
void setId(const string& _id);
};
#endif //_MEMBER_H_
設定ファイルを生成する
まず、設定ファイルのテンプレートを作成します。 設定ファイルは以下のコマンドで作成できます。
doxygen -g <config-file>
<config-file>は省略可能です。省略した場合は Doxyfile という名前で作成されます。
ここでは省略してデフォルトの Doxyfile を作成します。 DOSプロンプトから、上記ソースを格納しているフォルダに移動して以下のコマンドを入力します。 (ソースの格納先は設定ファイルに指定できますが、デフォルトがカレントになっていますので、 ソースの格納フォルダで行います)
doxygen -g
コマンドを入力したフォルダ上に Doxyfile という名前で設定ファイルが作成されます。
ここでは最低限の設定し、後はデフォルトで動かしてみます。
- PROJECT_NAME
- プロジェクト名です。日本語の記述もできましたが、 ウイザードで設定する場合はGUIが日本語に対応していませんのでできませんでした。
- OUTPUT_LANGUAGE
- 日本語で出力する場合、Japaneseと指定します。 コメントに日本語が含まれている場合はJapaneseと指定しなければ化けます。
以下のように設定し、保存します。
: PROJECT_NAME = サンプル : OUTPUT_LANGUAGE = Japanese :
Doxygenの実行
実行は以下の形式で指定します。
doxygen <config-file>
<config-file>は省略可能です。省略した場合は Doxyfile という名前を設定ファイルを読み込みます。
上記で設定ファイルは Doxyfile としましたので、 コマンドプロンプトより、以下のコマンドを入力します。入力は設定ファイルが存在しているフォルダ上で行います。
doxygen
設定は、ほぼデフォルトのままですので、 ソースの入力フォルダはカレント、出力フォルダもカレントとなっています。
実行すると html フォルダと latex フォルダが作成されます。html にはHTML形式、latex フォルダはLaTeX形式で出力されます。
作成したドキュメント
作成したドキュメントは以下になります
デフォルトではこのようなドキュメントが作成されます。
