2017-02-23 6 views
0

У меня есть несколько функций, которые должны быть описаны в doxygen, где 80% описания одинаковы. Я могу скопировать его поверх них, но иногда это описание меняется, и поддержка изменений во всех этих функциях становится головной болью.Использовать тот же текст несколько раз в doxygen

Есть ли способ в doxygen создать именованный текстовый блок, который будет набираться только один раз, и каждая функция сможет его использовать?

Нечто подобное:

//! /textblock <supername> that is the text that I would like to have just once, but that should appears in different places in documentation 
... 
//! my function 1. /useblock <supername>. Just as it is. 
void func1() { return; } 
... 
//! my function 2. /useblock <supername>. Yeah, make sense. 
void func2() { return; } 
... 
//! my function 3. /useblock <supername>. Such great it is. 
void func3() { return; } 
+0

Я думаю, что \ snippetdoc - это команда, которую вы ищете. – albert

ответ

0

Я использовал «псевдоним» пользовательскую команду в Doxygen для реализации «фрагментов». См. https://www.stack.nl/~dimitri/doxygen/manual/custcmd.html. Хотя объяснение делает его похожим на то, что вы можете использовать его только для функций типа функции, это отлично подходит для повторного текста.

Смежные вопросы