Menu
When I'm commenting cvars I have a tendency to use the following format as I think it's easier to read.
UILabel *titleLabel; // The title label in the view
My current client uses doxygen and so I'm going back and converting my comments into doxygen format, which I hoped would be as simple as
UILabel *titleLabel; /// The title label in the view
Unfortunately this results in the comment being attached to the next cvar.
Is there any way of telling doxygen that single line comments should belong to the cvar on the line they are on ?
961
Once specified, you can generate the comment stub by typing the respective “///” or “/**” above a function, or by using the (Ctrl+/) shortcut.
The common sense tells that the Doxygen comment blocks have to be put in the header files where the classes, structs, enums, functions, declarations are.
Putting the command @brief will generate a short description of the function when you generate the doxygen documentation. That short description can be extended if you want.
Notes: As pointed out in the Doxygen documentation for the ALIAS tag, you can put \n's in the value part of an alias to insert newlines. Ok, although the build people are going to complain that I'm wasting my time and their with minutiae rather than doing actual work...
I think you are missing a <, try using:
UILabel *titleLabel; ///< The title label in the view
See the doxygen manual for more information.
184
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
