Javadoc: всего один комментарий для нескольких объявлений глобальных переменных
Я документирую исходный код, написанный на C ++, используя Doxygen. У меня есть файл, который содержит только определения констант, например:
// Flags for A
const int A = 0;
const int A1 = 1;
const int A2 = 2;
// Flags for B
const int B = 0;
const int B1 = 1;
const int B2 = 2;
Что я хочу это javadoc синтаксис для создания документации для A флаги и для B Флаги отдельно. Я не хочу разделять их по разным файлам и не писать комментарии к каждому из этих констант.
Это возможно? Если это так, как?
Решение
Вы можете заключить их в группу Doxygen:
/*!
* \addtogroup A_Flags
* @{
*/
const int A = 0; //!< Bit zero;
const int A1 = 1; //!< Bit position 1;
const int A2 = 2; //!< Bit position 2;
/*! @} End of group A_Flags *//*!
* \addtogroup B_Flags
* @{
*/
const int B = 0; //!< Bit zero;
const int B1 = 1; //!< Bit position 1;
const int B2 = 2; //!< Bit position 2;
/*! @} End of group B_Flags */
Я сделал нечто подобное с нашими регистрами FPGA, детализируя значения битов.
/*!
* @addtogroup FPGA_CLEAR_WATCHDOG_FAULT_MAP
* @{
* \image html FPGA_Clear_Watchdog_Fault_Register.JPG "Clear Watchdog Fault Register"*/
/*! Clear Watchdog Fault flag.\n
* <code>
* binary: 0000 0000 0000 0001\n
* hex: 0 0 0 1\n
* </code>
*/
#define FPGA_CLEAR_WATCHDOG_FAULT (0x0001U)
/*! Inform FPGA of shutdown
* <code>
* binary: 0000 0000 0000 0010\n
* hex: 0 0 0 2\n
* </code>
*/
#define FPGA_INFORM_SHUTDOWN (0x0002U)
/*! @} End of Doxygen group FPGA_CLEAR_WATCHDOG_FAULT_MAP*/
Другие решения