Re: [Doxygen-users] Use of \retval and \return
Brought to you by:
dimitri
From: Emil M. <mx...@se...> - 2006-01-05 09:51:49
|
According to Doxygen Manual, for input/output function parameters you can better use @param command optional attribute "in" or "out" @param[in] myinputparam My parameter description @param[out] myoutputparam My parameter description @param[in,out] myinoutparam My parameter description The "@return" command should IMHO be used for the arbitrary return description, and "@retval <return value>" for the description of named return value, e.g.: @return Returns @c true in the case of success, @c false otherwise. or @retval ERROR_SUCCESS No errors. @retval ERROR_FILE_NOT_FOUND Error - file not found. @retval ERROR_MEMORY Error - not enough memory. etc. Braden McDaniel wrote: > On Wed, 2006-01-04 at 16:40 +0200, Moshe Kruger wrote: > >>Hi all, >> >>Can users of this list tell me about their of use of the doxygen tags >>\retval and \return. >> >>Beyond the syntactical difference (\retval can take the name of the >>return value), is there a difference in meaning? > > > As I understand it, \retval is for "out" params. > |