문서를 생성하기 위해 Doxygen을 사용하는 프로젝트가 있습니다. 클래스의 문서는 괜찮지 만, main()에서 객체 등을 만들기 위해 사용하는 몇 가지 함수가 있습니다. 이것들을 내 문서에 넣고 싶습니다. 그러나 어떻게해야하는지 알지 못했습니다. 어떤 제안? 당신이 그렇지 않으면 "다른 장소에서 문서"에 대한 귀하의 \\*!*\ 블록에Doxygen을 사용하여 C++에서 함수 문서화
http://www.doxygen.nl/docblocks.html
모습을 \class를 사용
사용 \fn는
이 문서화와 유사한 작동 패턴이 우리를 위해 잘 작동했습니다.
/*! Convert counts to kg for the reservoir.
\param counts The A/D counts to convert.`
\return The calculated kg based on the parameter.
*/
float RES_ConvertCountsToValue(uint_16 counts);
나는이 패턴을 자신의 클래스가 문서화되어있는 경우 클래스의 구성원은 문서화되어 있습니다
///////////////////////////////////////////////////////////////////////
/// \brief setX
/// \param x offset of the image.
/// \return a new image as an QImage.
/////////////////////////////////////////////////////////////////////////
QImage setX(int x);
엔티티를 좋아한다. 네임 스페이스 범위에서 선언 된 개체는 네임 스페이스가 문서화 된 경우에만 문서화됩니다. 파일 범위에서 선언 된 개체는 파일이 문서화 된 경우에만 문서화됩니다.
/** @file */
또는이 같은 :
/*! \file */