[Doxygen-users] doxygen commenting with //!< not working for last parameter of C++ methods
Brought to you by:
dimitri
From: Greg E. <er...@se...> - 2018-05-11 19:03:41
|
I'm embarking on a C++ project, and want to get the doxygen comments right before the project gets too far along. I'd like to use //!< to comment the function/method parameters, but the coding style of the project seems to be causing trouble when it's used on the last argument: __________________________________________________________________ snip /// Send a message to main application asking for a result /// /// \returns a single string reply from the app. /// string AskApp(const char *cmd, //!< command to send app const string& arg) { //!< argument to command if ( arg == "" ) { ..stuff.. } ..stuff.. } __________________________________________________________________ snip It seems doxygen can't deal with this bracing style, with the opening brace being on the same line as the argument: warning: The following parameters of AddLetterDialog::AskApp(..) are not documented: parameter 'arg' I'll use @param if I have to, as I've used that on other projects that use this same bracing style (FLTK), but it's too easy for the @param comments to get out of sync with the code if the argument name changes. So //!< seems preferable. It also makes for less lines in the code. Is there a Doxyfile flag I'm missing for bracing style, or is this a bug? PS. Also, with the //!< comment style, for some reason doxygen is putting the parameters BELOW the return docs instead of above, which seems counter to convention. |