On Thu, 14 Oct 2010, Carsten Haitzler (The Rasterman) wrote:
> On Thu, 14 Oct 2010 08:45:58 +0200 (CEST) Vincent Torri <[email protected]> > said: > >> >> >> On Thu, 14 Oct 2010, Carsten Haitzler (The Rasterman) wrote: >> >>> On Thu, 14 Oct 2010 07:55:51 +0200 (CEST) Vincent Torri >>> <[email protected]> said: >>> >>>>> as for api docs i'd love to at least see every api func have a template >>>>> "fill me in" doxygen doc comment. if we can - fill them in. >>>> >>>> I disagree here. Having no doc for a function make doxygen display a >>>> warning in the terminal. Which means we *know* that there is a problem and >>>> the doc must be fixed. Otherwise we would have to read all the doc to see >>>> if we have filled correctly or not the doc. I prefer having an automated >>>> way of warning me about that, instead of reading the whole doc. >>> >>> i have tested this and it definitely doesn't. >> >> of course it does. run 'make doc' in eio for example. I get: >> >> /home/torri/svnroot_anon/eio/src/lib/Eio.h:113: warning: Member eio_shutdown >> (void) (function) of group Eio_Group is not documented. >> >> You just didn't do the correct things in the files for doxygen to display >> them. > > try it in ecore. i did try it. i checked calls that are not documented. zero > complaints. I'll check that. I was anyway working on the ecore doc these days Vincent ------------------------------------------------------------------------------ Beautiful is writing same markup. Internet Explorer 9 supports standards for HTML5, CSS3, SVG 1.1, ECMAScript5, and DOM L2 & L3. Spend less time writing and rewriting code and more time creating great experiences on the web. Be a part of the beta today. http://p.sf.net/sfu/beautyoftheweb _______________________________________________ enlightenment-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
