Doxygen комментарий внутри макроса - PullRequest
Новая
       28

Doxygen комментарий внутри макроса

1 голос
/ 31 мая 2011

Моя проблема заключается в следующем: у меня есть набор файлов с одинаковыми параметрами для конструкторов.Я определил параметры конструктора внутри макроса, который используется в каждом файле.Например, следующий конструктор: 

Planar(BSPF_IMAGE_FORMAT_STD_CONST_PARAMS_3);

использует макрос BSPF_IMAGE_FORMAT_STD_CONST_PARAMS_3, который расширяет параметры конструктора Planar: 

#define BSPF_IMAGE_FORMAT_STD_CONST_PARAMS_3                                \
  size_t height,                                                            \
  size_t width,                                                             \
  size_t stride,                                                            \
  size_t effectiveChannels,                                                 \
  BSPF_UTILS::bspf_8u* buffer

Моя проблема заключается в следующем: я хочу иметь то же самоеДокументация Doxygen для всех конструкторов, использующих один и тот же макрос, иными словами, я хочу написать один раз документацию для конструкторов, совместно использующих один и тот же макрос).

Как я могу это сделать?

Я пытался написать макрос (с именем конструктора для параметра), но он не работает, так как Doxygen расширяет макрос без переноса строки.

Есть ли хороший способ сделать это?

Спасибо за ваши ответы.

1 Ответ

2 голосов
/ 31 мая 2011

Макросы всегда расширяются без разрыва строки, это никак не связано с doxygen.Однако решение относительно простое:

Иметь дополнительный текстовый файл ("BSPF_IMAGE_FORMAT_STD_CONST_PARAMS_3.txt" или аналогичный), который содержит комментарий, специфичный для этого определения, дополнительный 

#define BSPF_IMAGE_FORMAT_STD_CONST_PARAMS_3_INCLUDE \ 
    "BSPF_IMAGE_FORMAT_STD_CONST_PARAMS_3.txt"

и, наконец, использоватьэто следующим образом: 

// your .cpp
#include BSPF_IMAGE_FORMAT_STD_CONST_PARAMS_3_INCLUDE
Planaer::Planar(BSPF_IMAGE_FORMAT_STD_CONST_PARAMS_3){
}

Включение с просто скопировать и вставить содержимое .txt в ваш .cpp, и все.

...