Doxygen 不识别记录的功能等

Question

我刚刚开始使用 doxygen (1.9.0)。我已将我认为正确的注释块添加到几个函数以及我的 C 项目中的 typedef 和 enum。但是，当我运行doxygen dconfig时，结果HTML只包含我的源代码和none文档

这是我的文档示例。

/**
*   \enum grrRetValue
*   \brief Function return values.
*
*   Any function in the Grr API which returns an int returns one of these
*   values.
*/
enum grrRetValue {
    GRR_RET_OK = 0, //!< The function succeeded.
    GRR_RET_NOT_IMPLEMENTED, //!< The requested functionality has not yet been implemented.
    GRR_RET_DONE, //!< A recursive task has finished.
    GRR_RET_NOT_FOUND, //!< The requested item was not found.
    GRR_RET_OUT_OF_MEMORY, //!< Memory allocation failure.
    GRR_RET_BAD_DATA, //!< Invalid data was passed to the function.
    GRR_RET_FILE_ACCESS, //!< A file read/write failed.
    GRR_RET_OVERFLOW, //!< A buffer overflow occurred.
    GRR_RET_EXEC, //!< A call to exec failed.
    GRR_RET_OTHER, //!< A generic error occurred which is not covered by the above options.
};

/**
*   \typedef grrNfa
*   \brief An opaque reference to Grr's regex object.
*/
typedef struct grrNfaStruct *grrNfa;

和

/**
*   \fn grrCompile
*   \brief Compiles a string into a regex object.
*   \param string The string to be compiled (does not have to be zero-terminated).
*   \param len The length of the string.
*   \param nfa A pointer to the Grr regex object to be populated.
*   \return GRR_RET_OK if successful and an error code otherwise.
*
*   Possible error codes:
*       - GRR_RET_OUT_OF_MEMORY
*       - GRR_RET_BAD_DATA (the string contained non-printable characters)
*/
int grrCompile(const char *string, size_t len, grrNfa *nfa);

如果您需要查看 dconfig 中的任何选项，请告诉我。

Answer 1

这些症状看起来很像缺少 \file 命令。在你的文件开头放置一个 doxygen 注释，例如 /** \file */ 然后再试一次。

Doxygen 不识别记录的功能等

Doxygen not recognizing documented functions et al

c

doxygen