On Mon, 25 Oct 2010 09:42:43 +0200 Cedric BAIL <cedric.b...@free.fr> said:
> > the html docs should work offline too... just bring up index.html in a > > browser. > > I actually think that putting in each "root" header a link to the auto > generated doc will help people that are looking at our API. We could > also take into account the version when we do a release and point them > to the right version of the doc online. This could be automatic. aaah that is indeed an issue yet undiscussed. we auto-generate docs for whatever trunk has. fine until we do evas2.0 or any api break.. as docs wont be "wrong" - they may just document new features not yet available in your versions of evas/edje/eina/whatever. so as of 1.0 we do NEED to make sure we clearly document as of when a feature is available (after 1.0 next round of features will be 1.1 - so any features and api's added need to be marked as added in 1.1). unless we want to generate new docs per minor version of evas? anyway - still.. the question is being tossed back and forth. we have 2 sides. in .h or not. i ask this. read Eet.h - is that hard to use/read? would you prefer... Ecore.h for example? (actually while i'm at it.. the tonne of eina headers... i'm not too fond of.. but we won't be changing this any time soon methinks). also one other thing. if we put API docs in the public .h - we can separately document internal info in the .c files - it's at least easier to handle doc-wise that trying to put different comment snippets within the same files in different doxygen sections (hell u'd want them in 2 separate documents at the end of the day). -- ------------- 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
