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. Vincent > in fact its not possible for > doxygen to do this. well not unless it considers EVERY function - that > includes > internal ones (static, inlined and just internal shared funcs) and then you'd > have to pick which ones are EAPI and in the exported .h and which are not. i > have tested this - doxygen says NOTHING about undocumented api's when i do > "make doc". ------------------------------------------------------------------------------ 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
