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?

Yes. But I always used the Gui interface for that.

If yes please enable it in
sourcedoc/Doxyfile.in.

I didn't know we had that. Will do as soon as I can.


/// 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. Nevertheless the change is wrong, it is missing the
dot ;-(

I will add the dot or I can revert to /** style, I don't really care. Someone needs to review all the doxygen comments someday...

Abdel.

Reply via email to