On Sun, 17 Jul 2011, Carsten Haitzler (The Rasterman) 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. common users don't read .h files... They want either browsable doc, or a tool like devhelp (i begun such tool in 2005, in trunc/doc/api). Imho, it's the way to do it (you can even use such tool in your favorite code editor) Vincent > if u want a quick ref, this can be generated just removing all comments (a bit > of sed work methinks could do the job). > > -- > ------------- Codito, ergo sum - "I code, therefore I am" -------------- > The Rasterman (Carsten Haitzler) ras...@rasterman.com > > > ------------------------------------------------------------------------------ > AppSumo Presents a FREE Video for the SourceForge Community by Eric > Ries, the creator of the Lean Startup Methodology on "Lean Startup > Secrets Revealed." This video shows you how to validate your ideas, > optimize your ideas and identify your business strategy. > http://p.sf.net/sfu/appsumosfdev2dev > _______________________________________________ > enlightenment-devel mailing list > enlightenment-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/enlightenment-devel > > ------------------------------------------------------------------------------ AppSumo Presents a FREE Video for the SourceForge Community by Eric Ries, the creator of the Lean Startup Methodology on "Lean Startup Secrets Revealed." This video shows you how to validate your ideas, optimize your ideas and identify your business strategy. http://p.sf.net/sfu/appsumosfdev2dev _______________________________________________ enlightenment-devel mailing list enlightenment-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
