Georg Baum wrote:
Abdelrazak Younes wrote:
Georg Baum wrote:
[EMAIL PROTECTED] wrote:
- /// a function should be executed from the workarea
+ /// dispatch method that should be executed from the workarea
+ /// \return true if a full redraw is needed.
bool workAreaDispatch(FuncRequest const & ev);
/// comments may not have the \return keyword. You need /** */ or /*! */
for that.
Well, it depends on how you configure Doxygen. I use the following style
in my own code:
configure means the Doxyfile? If yes please enable it in
sourcedoc/Doxyfile.in.
/// small title.
/// bla bla bla
/// ...
/// \return ...
/// \retval ...
It works fine provided that you put the dot at the end of the small title.
I did not know that. I remember getting warnings about this with LyX code,
but then I probably did not have a dot, or it is not enabled in
sourcedoc/Doxyfile.in.
It seems it is already enabled:
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
# include brief member descriptions after the members that are listed in
# the file and class documentation (similar to JavaDoc).
# Set to NO to disable this.
BRIEF_MEMBER_DESC = YES
and:
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
# will interpret the first line (until the first dot) of a JavaDoc-style
# comment as the brief description. If set to NO, the JavaDoc
# comments will behave just like the Qt-style comments (thus requiring an
# explict @brief command for a brief description.
JAVADOC_AUTOBRIEF = YES
