Javadoc 및 Doxygen을 사용하여 파일 자체를 주석 처리하는 방법

Question

javadoc 스타일 및 doxygen을 사용하여 파일 자체를 문서화하는 데 문제가 있습니다. 변수와 함수에 대한 멋진 문서를 생성 할 수 있지만 파일 자체에 대해 doxygen은 var 또는 매크로에 자체 javadoc 주석 블록이 있어도 파일의 헤더가 다음 직접 변수 또는 매크로의 문서라고 생각합니다. 아래의 예를 보자 나는 (doxygen이/doxywizard를 사용하여)이 파일 정의 된 매크로에 대한 문서를위한 문서를 생성 할 때

/** 
* 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 

가 그래서, 파일의 헤더로 대체됩니다.

그런 올바른 방법은 무엇입니까? 설명, 작성자, 시간, 버전 등의 정보가 포함 된 파일 자체를 문서화하는 것이 좋습니다. 그렇다면 방금 설명한 문제를 해결하는 방법은 무엇입니까?

Answer 1

\file 명령을 사용하십시오.

/** \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 :