On Fri, 22 Oct 2010 07:31:48 +0200 (CEST) Vincent Torri <vto...@univ-evry.fr> said:
> > > On Fri, 22 Oct 2010, Carsten Haitzler (The Rasterman) wrote: > > > ok as a general thing. this isn't any api break. > > > > doxyegen doc comments. should they go in .c files or in .h files? good > > question. eet has it all in Eet.h. the rest of efl has it in .c files. a > > good case has been made for it being in .h files instead of .c - that > > developers actually do read the .h files and then dont see the docs. they > > need to go get the src separately OR find the separately generated docs. > > having it all there in 1 place already shipped and installed is useful as > > docs are ready to read without needing to find the pretty generated html > > ones (or man pages). another bonus - it's instantly obvious what functions > > are and are not documented. > > > > what do people think? move docs to .h file(s)? (its really mostly a > > mechanical thing). > > I like having the doc in .h. > > Another related question: should we install doc ? For now, it is built > only with 'make doc' and a tarball is built with html, latex and man doc. that is a good question. as such this may conflict with packagers and distros so for now i'd lean to "no". especially if we put doxy comments in .h's -- ------------- Codito, ergo sum - "I code, therefore I am" -------------- The Rasterman (Carsten Haitzler) ras...@rasterman.com ------------------------------------------------------------------------------ Nokia and AT&T present the 2010 Calling All Innovators-North America contest Create new apps & games for the Nokia N8 for consumers in U.S. and Canada $10 million total in prizes - $4M cash, 500 devices, nearly $6M in marketing Develop with Nokia Qt SDK, Web Runtime, or Java and Publish to Ovi Store http://p.sf.net/sfu/nokia-dev2dev _______________________________________________ enlightenment-devel mailing list enlightenment-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
