On Tue, 26 Jul 2011 17:42:26 -0400 Mike Blumenkrantz <m...@zentific.com> said:

docs in headers stay there and get expanded.

> On Sun, 17 Jul 2011 21:39:50 +0900
> Carsten Haitzler (The Rasterman) <ras...@rasterman.com> wrote:
> 
> > On Sat, 16 Jul 2011 09:23:45 -0400 Mike Blumenkrantz <m...@zentific.com>
> > said:
> > 
> > > With the recent infusion (profusion?) of documentation, our header sizes
> > > have become, imo, WAAAAAAY too big. They are entirely impossible to
> > > navigate, and this is a problem that will only get worse.
> > > 
> > > As an example, the elm .h file is over 10k lines already, and I have to
> > > scroll quite a bit to find something when I am looking for it (since all
> > > the doxygen tags break scintilla as it is...).
> > > 
> > > Something must be done! Bring back the readable headers!!!
> > 
> > you could just strip all comments from the headers and use them....
> > but i thought you use geany and ctags files.. so why would you need to read
> > them?
> > 
> > this was hashed over. we are required to put some of the doxy docs in the
> > headers anyway - enums structs, macros for example. so this means our docs
> > are split between private and public files. if we put them all in public
> > headers we c an generate docs from installed headers. also people have
> > expressed a desire for the docs there so they can read the docs in the .h
> > file.
> > 
> > if u want a quick ref, this can be generated just removing all comments (a
> > bit of sed work methinks could do the job).
> > 
> in all seriousness, this is a problem. elm's header is approaching 20k lines
> and that's really not acceptable for a header.
> 
> -- 
> Mike Blumenkrantz
> Zentific: Coding in binary since '10.
> 
> ------------------------------------------------------------------------------
> Got Input?   Slashdot Needs You.
> Take our quick survey online.  Come on, we don't ask for help often.
> Plus, you'll get a chance to win $100 to spend on ThinkGeek.
> http://p.sf.net/sfu/slashdot-survey
> _______________________________________________
> enlightenment-devel mailing list
> enlightenment-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
> 


-- 
------------- Codito, ergo sum - "I code, therefore I am" --------------
The Rasterman (Carsten Haitzler)    ras...@rasterman.com


------------------------------------------------------------------------------
Got Input?   Slashdot Needs You.
Take our quick survey online.  Come on, we don't ask for help often.
Plus, you'll get a chance to win $100 to spend on ThinkGeek.
http://p.sf.net/sfu/slashdot-survey
_______________________________________________
enlightenment-devel mailing list
enlightenment-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-devel

Reply via email to