CODEWITHSUNDEEP
objective-cdocumentationdoxygen
Dean Smith
Dean Smith

Reputation: 2183

Doxygen /// comments at end of line

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 ?

Upvotes: 11

Views: 10543

Answers (1)

Sam D
Sam D

Reputation: 470

I think you are missing a <, try using:

UILabel *titleLabel; ///< The title label in the view

See the doxygen manual for more information.

Upvotes: 23

Related Questions