On Fri, 13 Feb 2004, Nathan Ingersoll wrote:

> I'm curious what aspects of doxygen you don't like. Could you elaborate
> a bit?
> 
> Thanks.

well, while i am writing my answer, i am looking at the ewl's api.

1) several redundancies for functions, structs etc..
2) no logical links: the structures are not with their related functions
for example.
3) no hierarchy (your library follows an object structure)

the first time i looked at the ewl's api, i was completely lost. Perhaps i
don't know how the informations are organized in the doc provided by
doxygen, but i find that the api of gtk clear and efficient. It is well
organized and you find informations straightforwardly. 

best regards

Vincent TORRI

> 
> -- 
> ------------------------------------------------------------------------
> | Nathan Ingersoll          \\  Computer Systems & Network Coordinator |
> | [EMAIL PROTECTED]   \\  http://www.ruralcenter.org            |
> | http://ningerso.atmos.org/  \\  Rural Health Resource Center         |
> ------------------------------------------------------------------------
> 
> On Fri, Feb 13, 2004 at 09:50:53PM +0100, Vincent Torri wrote:
> > 
> > > Nathan Ingersoll wrote:
> > > > 
> > > > All:
> > > > * Docs, docs, and more docs.
> > > > 
> > > Ahh...finally something I can probably handle.  If no one else wants to 
> > > do the docs that's probably something I can handle.  I can definitely 
> > > work on the user docs, and at least take the brunt of the dev docs on.
> > > 
> > > If someone wants to give me some direction on how they see the docs in 
> > > terms of the technology used and basic formats, I will do what I can. 
> > > This would also be a great way for me to learn more about Enlightenment, 
> > > and potentially contribute code in the future.
> > 
> > I have already talked with Raster about the doc of the EFL. 
> > 
> > As i find that doxygen makes awful docs and as i find the api doc of gtk
> > clean and efficient, i tried to understand how gtk-doc works.
> > 
> > Now, i am able to provide a small project, with includes
> > 1) a unique document with all the api of the EFL 
> > 2) which can be themeable with a stylesheet file
> > 3) like doxygen, the source must be documented, in order to produce the
> > doc
> > 
> > The main "problem" is that gtk-doc comments are different from the doxygen
> > comments. So all the comments in your libs should be re-written (or
> > gtk-doc may be hacked, perhaps). You can use a lisp mode in emacs to
> > insert easily the comments.
> > 
> > I have no news from Raster for several days, so, As xcomp and rbdpngn put
> > the doc in the higher priority, if you are interested, I can give you this
> > project.
> > 
> > best regards
> > 
> > Vincent TORRI
> > 
> > 
> > 
> > -------------------------------------------------------
> > SF.Net is sponsored by: Speed Start Your Linux Apps Now.
> > Build and deploy apps & Web services for Linux with
> > a free DVD software kit from IBM. Click Now!
> > http://ads.osdn.com/?ad_id=1356&alloc_id=3438&op=click
> > _______________________________________________
> > enlightenment-devel mailing list
> > [EMAIL PROTECTED]
> > https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
> 
> 



-------------------------------------------------------
SF.Net is sponsored by: Speed Start Your Linux Apps Now.
Build and deploy apps & Web services for Linux with
a free DVD software kit from IBM. Click Now!
http://ads.osdn.com/?ad_id=1356&alloc_id=3438&op=click
_______________________________________________
enlightenment-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-devel

Reply via email to