23

Doxygen（Mac OS X Snow Leopardでは1.6.1）には、何をしても列挙型が文書化されていないように見えるという、かなり奇妙な問題があります。私はCでプログラミングしており、マニュアルの指示に従いました。これが私のコードです：

/**
 * \enum dccp_pkt_type 
 * \brief specifies the available DCCP packet types
 */

enum dccp_pkt_type
{
    DCCP_REQUEST    = 0,    /**< DCCP Request Packet */
    DCCP_RESPONSE,          /**< DCCP Response Packet */
    DCCP_DATA,              /**< DCCP Data Packet */
    DCCP_ACK,               /**< DCCP Ack Packet */
    DCCP_DATAACK,           /**< DCCP Data Ack Packet */
    DCCP_CLOSEREQ,          /**< DCCP Close Request Packet */
    DCCP_CLOSE,             /**< DCCP Close Packet */
    DCCP_RESET,             /**< DCCP Reset Packet */
    DCCP_SYNC,              /**< DCCP Sync Packet */
    DCCP_SYNCACK,           /**< DCCP Sync Ack Packet */
    DCCP_RESERVED,          /**< DCCP Reserved Packet Type - Receivers MUST
                         ignore any packets with this type */
};

doxygenのマニュアルによれば、適切に文書化された出力を生成するはずですが、代わりに何も生成しません。私はおそらく単純な何かを見逃しているでしょう、誰かが私を正しい方向に向けることができれば私は感謝するでしょう。

4

3 に答える 3

36

Doxygenマニュアルから：

見過ごされがちなので、繰り返しましょう。グローバル オブジェクト (関数、typedef、enum、マクロなど) をドキュメント化するには、それらが定義されているファイルをドキュメント化する必要があります。つまり、少なくとも

/*! \file */または

/** @file */このファイルの行。

于 2009-11-11T20:52:11.397 に答える
10

私の経験は、doxygen 1.8.9.1 を使用した場合と使用した場合と同じです。EXTRACT_ALL=NOグローバルな列挙型が存在し、グローバルが文書化された複合構造によって参照されSHOW_INCLUDE_FILES=NOていても、リストもリンクもされませんでした。/*! \file */enum

これを回避するために、Enumerations グループを定義することになりました。

/*! \defgroup Enumerations Public enumeration types */

列挙型については\ingroup Enumerations、新しいグループに列挙型を含めていました。その後、Doxygen は複合構造から列挙型に自動リンクすることができました。

于 2015-03-08T18:12:43.033 に答える
4

メモリが正しく機能する場合、ファイルもドキュメント化されていない限り、列挙型ドキュメントは表示されません。@fileセクションを追加してみてください。

于 2009-11-11T20:48:32.667 に答える