Use same text multiple times in doxygen

Question

I have few functions, that should be described in doxygen where 80% of description is the same. I can copy-paste it over them, but sometimes this description is changing, and supporting changes in all those functions is becoming headache.

Is there a way in doxygen to create a named text block, that will be typed just once, and each function will be able to use it?

Something like that:

//! /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; }

I think the \snippetdoc is the command you are looking for.

albert
– albert

2017-02-23 17:47:48 +00:00
Commented Feb 23, 2017 at 17:47 — albert
– albert, Commented Feb 23, 2017 at 17:47

albert · Accepted Answer · 2018-12-16 14:12:07Z

1

I've used the "alias" custom command in doxygen for implementing "snippets". See http://www.doxygen.nl/manual/custcmd.html. Although the explanation makes it look like you can use this only for function-type things, it's great for repeated text.

edited Dec 16, 2018 at 14:12

albert

9,2103 gold badges24 silver badges42 bronze badges

answered Feb 23, 2017 at 15:54

user6635974

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Use same text multiple times in doxygen

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related