Re: doxygen @short directive in comments

[Federico Montesino Pouzols]

        Um, yes this should be fixed. Another pending issue with the
doxygen doc is that, as reported sometime ago, ost::Exception does not
appear in it. This is because there is a specific doc/cc++/config.h
for doxygen which only defines a few configuration constants. Should
not we remove this file and simply use the config.h generated by
configure?

On Fri, Jan 03, 2003 at 11:45:23PM +0200, Albert Strasheim wrote:
> Hello,
> 
> All the classes in Common C++ are documented as follows (MutexCounter 
> in thread.h used as example):
> 
> /**
>  * The Mutex Counter is a counter variable which can safely be incremented
>  * or decremented by multiple threads.  A Mutex is used to protect access
>  * to the counter variable (an integer).  An initial value can be specified 
>  * for the counter, and it can be manipulated with the ++ and -- operators.
>  * 
>  * @author David Sugar <address@hidden>
>  * @short Thread protected integer counter.
>  */
> class CCXX_CLASS_EXPORT MutexCounter : public Mutex
> {
> ...
> };
> 
> This is wrong. The problem is the position of the @short directive. 
> @short should be at the top of the class description, not the bottom, 
> e.g.:
> 
> /**
>  * @short Empty class.
>  *
>  * Class A is an empty class. Be happy.
>  *
>  * @author Albert Strasheim
>  */
> 
> This generates the proper HTML in doxygen -- you'll see that all the 
> current class descriptions currently don't read too well, since the 
> first sentence of the description, and the @short sentence are being 
> used for the description of the class that is placed at the top of the 
> generated page.
> 
> Cheers,
> 
> Albert
> 
> 
> _______________________________________________
> Bug-commoncpp mailing list
> address@hidden
> http://mail.gnu.org/mailman/listinfo/bug-commoncpp