doxdocgen icon indicating copy to clipboard operation
doxdocgen copied to clipboard

What languages are supported?

Open sdbbs opened this issue 1 year ago • 0 comments

Describe the bug

This is mostly a documentation bug:

There is no clear statement in the main README.md about which languages are supported.

The screenshots imply C++, however, C++ is never mentioned on that page (Ctrl-F "C++" - 0 results).

Then again, I can get a simple C function declaration parsed and Doxygen comment generated:

/**
 * @brief 
 * 
 * @param a 
 * @param b 
 */
void myfunc(int a, int b) {

}

... which is great!

( I usually just get "@brief" populated in the autogenerated comments for enums and structs; I thought at first that meant no support for these C constructs, but I've found examples here https://wiki.scilab.org/Doxygen%20documentation%20Examples that show that is likely the correct approach, since documenting the fields goes on the same line where the field is declared. I guess that is what https://github.com/cschlosser/doxdocgen/issues/278 is talking about - entering extra keywords in the autogenerated comment for structs and enums ).

So, I would just have loved some sort of a note in the main README, on what languages is this addon applicable to (C++ only, or also C, or maybe also other languages?)

sdbbs avatar Dec 31 '22 08:12 sdbbs