Повторяющийся текст Doxygen - PullRequest
0 голосов
/ 27 июня 2018

Во всех моих API у меня есть строка текста, которая повторяется. Есть ли способ разместить этот текст в одном месте и связать его с API?

Например, в приведенном ниже примере, как поместить «текст, общий для многих API», в одно место, вместо того, чтобы писать одно и то же во всех API?

/**                                                                            
 * @brief Function description                                        
 * @param [in] param function param description 
 * @return return description                                                         
 *                                                                              
 * @attention text that is common for many APIs
 ***********************************************************************/       
 int func(int param);

1 Ответ

0 голосов
/ 27 июня 2018

Если это всегда одна и та же строка, лучше всего определить для нее специальную команду с помощью и псевдонима в файле конфигурации doxygen (Doxyfile), см. Тег ALIASES

Для более длинных текстов можно использовать команду doxygen \includedoc.

...