Use doxygen to document an undeclared function in C ++.

I am working on a proprietary tool that uses a language similar to C ++ to define various methods. The tool provides its own compiler for compiling these methods into a .so file. It does not follow the C ++ definition-definition syntax, but otherwise it is very similar. Sample code is as follows:

method _foo::bar(var message) { // do something with 'message' here } 

I tried to document this method using doxygen as follows:

 /** * @brief this method does something with @a message. */ method _foo::bar(var message) { // do something with 'message' here } 

but this gave me a warning:

 warning: documented function `method _foo::bar' was not declared or defined. 

I tried adding @fn method _foo::bar() , @fn _foo::bar and @fn bar to the comment block (one by one), but none of them resulted in the @brief that was added to the document.

I searched here on Stack Overflow, and this post Doxygen Comments with undeclared functions in the C ++ headers is the closest to my question, but it doesn't quite fit my problem.

Is there a way to configure doxygen to create documentation for a function, regardless of the fact that it is not declared?

+4
source share

Source: https://habr.com/ru/post/1446741/


All Articles