Now that I have started looking at this, some observations. First, it could really do with some alphabetical sorting. Is there some method to get doxygen to deal with that?
Second, I'm listed twice in the authors, so are others. I can see that's due to inconsistencies in naming. For instance, I'm down as "David 'onefang' Seikel" and "David Seikel". Thirdly, the Lua docs are really hard to find. Only seem to be listed in the "Related Pages" page, which is a long list of pages in random order. Hard to find anything in that list. On Fri, 28 Dec 2012 19:33:55 -0200 Ulisses Furquim <[email protected]> wrote: > Hi, > > On Fri, Dec 28, 2012 at 7:24 PM, Lucas De Marchi > <[email protected]> wrote: > > On Fri, Dec 28, 2012 at 6:08 PM, Gustavo Sverzut Barbieri > > <[email protected]> wrote: > >> Hi all, > >> > >> We're trying to improve the docs for the single tree efl, but we > >> need some help. The task is simple, but most core devs won't have > >> time to do it: > >> > >> - move all doxygen docs from .c to .h > > > > I really hate our headers because of this. > > Why? It's useful to have documentation there and not in the .c files > so it's a bonus. :-) While I agree that looking for the docs in .h files is A) natural, and B) might be the only place you have to look if it's an installed package, there's a problem with that theory for Edje Lua. The problem is that for Lua scripters, there is no include file. The same would apply to Embryo, and possibly other bindings. For Edje Lua in particular, putting the docs in the .c file makes sense, there's no where else for them to go. Which is fine according to my theories above, Lua scripters are not gonna look in C header files for docs. C coders on the other hand, will be looking in C header files to find out what's available. They'll stumble across the docs while they are in there and not have to look any further for explanations. If it's a distro supplied package, they would have installed the relevant -dev packages, then they'll have .h headers. They wont have the .c source files. In both cases, the generated by doxygen files might be available where the .c source code is not, so that keeps everyone happy. I'll fix up my name, and link Edje Lua pages into the main Edje page, but I'll leave the Edje Lua docs in the .c source file. -- A big old stinking pile of genius that no one wants coz there are too many silver coated monkeys in the world.
signature.asc
Description: PGP signature
------------------------------------------------------------------------------ Master Visual Studio, SharePoint, SQL, ASP.NET, C# 2012, HTML5, CSS, MVC, Windows 8 Apps, JavaScript and much more. Keep your skills current with LearnDevNow - 3,200 step-by-step video tutorials by Microsoft MVPs and experts. ON SALE this month only -- learn more at: http://p.sf.net/sfu/learnmore_123012
_______________________________________________ enlightenment-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
