2016-07-27 5 views
1

javadocスタイルとdoxygenを使用してファイル自体を文書化する際に問題があります。変数と関数の素晴らしいドキュメントを生成することができますが、ファイル自体のために、doxygenはファイルのヘッダーがvarまたはマクロに独自のjavadocコメントブロックを持っていても、私は(doxygenは/ doxywizardを使用して)、このファイルのドキュメントを生成するときに定義されたマクロのドキュメントは、ファイルのヘッダによって置換されるので、JavadocとDoxygenを使用してファイル自体をコメントする方法

/** 
* MAX9611 Sensor I2C 
* 
* @author Saeid Yazdani 
* @date 01/07/2016 
* 
*/ 


#ifndef MAX9611_HPP 
#define MAX9611_HPP 

#include "stdint.h" //for uint and stuff 

/** 
* max9611 RS+ ADC value is 0 to 57.3V in 12bit 
* so to convert it to real voltage we need this constant 57.3/4096 
* this can be used for both RS+ and OUT adc values to be converted to real V 
*/ 
#define MAX9611_VOLT_MUL  0.0139892578125 

:以下の例を取ります。

このようなことを行う正しい方法は何ですか?記述、作成者、時間、バージョンなどの情報を含むファイル自体を文書化するのがよい習慣と考えられていますか?もしそうならば、今説明した問題を解決する方法はありますか?

+1

あなたは\ fileコマンドを見ていましたか? – albert

+0

@albertありがとう、そうです。多分あなたはそれを回答として投稿したいのですか? –

答えて

2

コマンドを使用してください。

Doxygenのマニュアルは、このサンプルコードを提供します。

/** \file file.h 
* A brief file description. 
* A more elaborated file description. 
*/ 
/** 
* A global integer value. 
* More details about this value. 
*/ 
extern int globalValue; 

link to the output

enter image description here

関連する問題