Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
I just started programming in Objective-C and found some example comments like the following:
/*!
@brief The UIImageView we use to display the image generated from the imageBuffer
*/
What is the purpose of @brief? Is this something related to a documentation system like Doxygen?
Yes. That is the standard format for a function description in doxygen, using the command
@brieffor a brief explanation.Maybe you are more familiar with the expression
\brief, but@briefis allowed too.You have all the variations explained in this section of the manual.
Putting the command
@briefwill generate a short description of the function when you generate the doxygen documentation. That short description can be extended if you want.