Re: [Protux-devel] Regarding general Mustux Project issues

[Luciano Giordana]

Wow.. this is very similar to javadoc. Surely I will use it :-)

On Tuesday 21 January 2003 02:55 pm, Martin Herren wrote:
> Luciano Giordana wrote:
> >That's what I meant, but I had KDoc in mind, not doxygen (is that
> > difficult to learn ?)
>
> no, the basics are quite easy, and you can generate man pages, latex and
> html documents and more.
>
> example:
>
> /*!
>  * \brief a short explanation of the function for the summary
>  *
>  * A longer more detailed explanation
>  *
>  * \param myParam you can describe the parameters
>  * \todo there is still a lot to do for this
>  * \bugs crashes sometimes
>  */
> void calculate(float myParam)
> {
> }
>
> of course you don't need to put all of these... you can put only the
> brief description, only the long, none... there are
> also lot's of additional commands, for inserting pictures,
> crossreference other functions and so on...
> http://www.doxygen.org
>
> /Martin
>
>
>
>
> _______________________________________________
> Protux-devel mailing list
> address@hidden
> http://mail.nongnu.org/mailman/listinfo/protux-devel

-- 
--
Best Regards
--
Luciano Giordana - Musician - Certified Java/GNU C++ Developer - Free Software 
Evangelist
Project Mustux - http://www.freesoftware.fsf.org/mustux
-- Once Palladium is up and running , I will become a hacker --