On Monday 11 January 2010 12:12:05 Frank Schaefer wrote:
> Tomáš Trnka schrieb:
> > Dne So 9. ledna 2010 19:58:23 Frank Schaefer napsal(a):
> >> /*!
> >>     \fn VideoDevicePool::open()
> >>  */
> >>
> >> What kind of code documentation ist that and how does it work ? It's not
> >> doxygen, right ?
> >
> > Hello Frank,
> >
> > actually, that is Qt code documentation style, one of the two Doxygen
> > (the other one is Javadoc) styles. See here for additional info:
> > http://www.stack.nl/~dimitri/doxygen/docblocks.html
> >
> > 2T
> 
> Hmm, thanks Tomáš, I've never seen this Qt-style before...
> Are there any good reasons for using it instead of the Javadoc-style ?
> (If not, why did they try to reinvent the wheel ? ;) )
> I see both styles beeing used, so I guess there is no clear policy ?
> 
> Cheers,
> Frank
> 

No policy really. javadoc style is prefered over Qt style, in general, using 
slash command names (like \param and \return), instead of at command names 
(like @param and @return) but you should go with whatever the majority of the 
file already is.
-- 
Matt
_______________________________________________
kopete-devel mailing list
kopete-devel@kde.org
https://mail.kde.org/mailman/listinfo/kopete-devel

Reply via email to