On Sun, 13 Nov 2011 03:56:47 +1000 David Seikel <onef...@gmail.com> wrote:
> On Sat, 12 Nov 2011 16:40:02 +0100 (CET) Vincent Torri
> <vto...@univ-evry.fr> wrote:
>
> >
> > On Sun, 13 Nov 2011, David Seikel wrote:
> >
> > > On Sun, 13 Nov 2011 01:22:56 +1000 David Seikel
> > > <onef...@gmail.com> wrote:
> > >
> > >> On Sat, 12 Nov 2011 16:12:18 +0100 Cedric BAIL
> > >> <cedric.b...@free.fr> wrote:
> > >>
> > >>> On Sat, Nov 12, 2011 at 3:48 PM, David Seikel
> > >>> <onef...@gmail.com> wrote:
> > >>>> On Sat, 12 Nov 2011 06:33:09 -0800 "Enlightenment SVN"
> > >>>> <no-re...@enlightenment.org> wrote:
> > >>>>
> > >>>>> Log:
> > >>>>> A few basic docs, just to show the sort of structure I'm
> > >>>>> aiming for.
> > >>>>>
> > >>>>> I don't know doxygen, and doxygen don't seem to quite
> > >>>>> understand what I want. Which is to document the lua side of
> > >>>>> things, but having the docs near the C functions that define
> > >>>>> them. Help me out please doxygen experts.
> > >>>>> Note the problem with edje:rect().
> > >>>>>
> > >>>>> Or I could just write one big blob. Ewwww.
> > >>>>
> > >>>> I'm putting this up so that people that actually know doxygen
> > >>>> can help me out.
> > >>>>
> > >>>> Basically I want to document the lua API itself, not the C
> > >>>> code, so that lua scripters know how to work with it. The lua
> > >>>> API is created by the C code though, so that's where the doc
> > >>>> comments go. Doxygen however does not understand about
> > >>>> creating lua docs from the underlaying C.
> > >>>>
> > >>>> I had just reorganised the code to be better for programmers to
> > >>>> read. This does not work well with the doxygen I have in this
> > >>>> example though. Note how the edje:rect() description is out of
> > >>>> place.
> > >>>>
> > >>>> So I want to have the doc comments near the C function that
> > >>>> implements any given lua function or "class". But then I need
> > >>>> doxygen to neatly list the classes, with their functions in a
> > >>>> single group. Preferably with the inheritance details also
> > >>>> mentioned.
> > >>>>
> > >>>> Yes, I know that I'll have to manually enter details about
> > >>>> function arguments, return values, etc. Doxygen wont be able
> > >>>> to sort that out. The question is, how do I convince doxygen to
> > >>>> gather things together and group them nicely on the page?
> > >>>
> > >>> Yop, yop. Did you look at edje_cc_handlers.c ? I think it does
> > >>> with edcref what you are trying to do for lua.
> > >>
> > >> I did. In fact there is similar lua stuff already from the old
> > >> lua code, though no examples for me to copy and pull apart. I
> > >> could not get it to work though, but I'll have another poke at
> > >> it.
> > >
> > > Hmm, I think that's still linear. I can't see how that pulls bits
> > > from all over the file and collects them into one group.
> > >
> > > I'm off to bed, might understand it more after sleep.
> >
> > try:
> >
> > /**
> > * @addtogroup My_Lua_Group My Lua group
> > *
> > * @{
> > */
> >
> > add your documentation. That documentation will be in the
> > "My_Lua_Group" group
> >
> >
> > /**
> > * @}
> > */
>
> Meh, could not sleep.
>
> That still is not pulling together the scattered parts of the group.
> Unless I'm still doing something wrong. The edje_cc_handlers.c stuff
> seems more concerned with formatting than consolidating bits.
>
> Perhaps it has something to do with the fact that looking at the
> results locally seems to not pick up the css?
>
> Just to make it more clear, say I have C code that defines a lua
> structure in this order -
>
> class A
> function A:foo()
> function A:bar()
>
> class B
> function B:baz()
>
> function A:baz_frobber()
>
> To make things easier for the developer, all things to do with baz are
> together in the source code, even if it's from different classes.
> Which means that bits of class A are scattered through the code.
> Doxygen does not actually understand that the C code is defining such
> a structure. But I want the doxygen to pull together the scattered
> bits of class A into one spot and document it as -
>
> class A
> function A:foo()
> function A:bar()
> function A:baz_frobber()
>
> class B
> function B:baz()
>
> I can see that I might just have to rearrange the code to keep doxygen
> happy, so long as the compiler is also happy. Arranging the code to
> make the developers happy comes in a poor third. B-(
http://sourceforge.net/projects/doxygen/forums/forum/130994/topic/4741651
Doxygen pretty much sucks at this. sigh
/me rearranges the source code, so I can at least get on with the damn
documentation. lol
--
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
------------------------------------------------------------------------------ RSA(R) Conference 2012 Save $700 by Nov 18 Register now http://p.sf.net/sfu/rsa-sfdev2dev1
_______________________________________________ enlightenment-devel mailing list enlightenment-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
