[epiar-devel] doxygen?

[Chris Walton]

No time to write a quick tutorial, but I think doxygen commenting is a good
thing.

If you find the backslashes ugly, you can comment in javadoc style as well
(my preference, actually), which looks like this:L

/** @class Font
 * @brief blah blah blah
 */
class Font
{
    /**
     * Frobnicates the Transmogrifier
     * @param i Transmogrifier index
     * @return true if successful, false otherwise
    bool Frobnicate(unsigned int index);
};

On Sun, Dec 27, 2009 at 7:54 AM, Christopher Thielen <chris at epiar.net>wrote:

> Could somebody write a simple doxygen tutorial on our Trac? Basically, how
> to use these comments, how to write them, etc. My IDE doesn't support them
> so I assume I'll have to generate HTML files for it?
>
> Also, real quick, somebody argue why doxygen is good again. Just from my
> immediate experience tonight, not knowing doxygen, I was just confused by
> this, and if my IDE doesn't support it, I'd have to generate HTML to look up
> functions, right?
>
> To be clear, I'm sure doxygen is a decent idea, I'd just like to hear the
> justification again.
>
> On Dec 26, 2009, at 10:51 PM, Matthew Zweig wrote:
>
> > On Dec 26, 2009, at 10:41 PM, Christopher Thielen <chris at epiar.net>
> > wrote:
> >
> >> Are these doxygen comments?
> >>
> >> /**\class Font
> >> * \brief Font class takes care of initializing fonts. */
> >>
> >> Did we decide to go ahead with it? Didn't anybody disagree? I was
> >> caught by surprise working on the code. I had assumed somebody was
> >> just leaving really ugly comments behind.
> >>
> >> - Chris
> >
> > Yes these are for doxygen.  We do want this style of comments. It will
> > add some extra symbols, but it adds readability and makes it easier
> > for people to join our project.
> >
> >> _______________________________________________
> >> epiar-devel mailing list
> >> epiar-devel at epiar.net
> >> http://epiar.net/mailman/listinfo/epiar-devel
> > _______________________________________________
> > epiar-devel mailing list
> > epiar-devel at epiar.net
> > http://epiar.net/mailman/listinfo/epiar-devel
>
>
> _______________________________________________
> epiar-devel mailing list
> epiar-devel at epiar.net
> http://epiar.net/mailman/listinfo/epiar-devel
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://epiar.net/pipermail/epiar-devel/attachments/20091227/7a871fd7/attachment.html