lua-users home
lua-l archive

[Date Prev][Date Next][Thread Prev][Thread Next] [Date Index] [Thread Index]

The lua doxygen preprocessor is extremely primitive, I spent some time getting it to parse the style of inheritance I use ( patterned after http://lua-users.org/wiki/InheritanceTutorial ) and generating class X : public Y { }  statements. That allowed me to get inheritance diagrams out of doxgen. I'd say that if you're willing to hack at the perl a bunch and add a bunch of tokens to your code that can turn off the preprocessor around particular bits of complex lua you can get something reasonable out of the preprocessor route. My perl code is pretty atrocious, and I wound up customizing the preprocessor heavily for my own code base.
 I'm wondering what someone with a real lua parser could do in terms of generating c-like code for doxygen to parse.

-Gedalia 

On Mon, Mar 28, 2011 at 10:06 PM, KHMan <keinhong@gmail.com> wrote:
On 3/29/2011 9:53 AM, joshua simmons wrote:
On Tue, Mar 29, 2011 at 12:49 PM, KHMan wrote:

   On 3/29/2011 9:13 AM, Alexander Gladysh wrote:

       Recent discussion about module() function reminded me of a
       question I
       wanted to ask for some time.

       I keep stumbling upon or hearing about a plethora of hacks
       that people
       do to reuse LuaDoc for their code. (I, myself, never tried
       to use it
       actually — being scared off by all these hacks.)

       So, I have a question: why hack around and why not to fix
       the tool (or
       write a new one for that matter)?


   I've been wondering too... add Lua support to Doxygen and
   everyone gets easy access to a mature and widely-available
   documentation tool. Have anyone tried going the Doxygen route?
[snip]


Doxygen is also large and cumbersome.

Since Lua is so dynamic I don't think it lends itself to existing
documentation systems. That's a purely arbitrary statement though,
I'd be interested if somebody had actually tried this.

There is a Lua-Doxygen preprocessor that was mentioned on the list before. But apart from that, I heard not much else.

Yeah, it's non-ideal, but perhaps pretty convenient for end-users or Doxygen users who want it and can get it installed easily. Nicer to be the end users rather than the developer of course...


--
Cheers,
Kein-Hong Man (esq.)
Kuala Lumpur, Malaysia




--
---------------------------------------------------------------
cel: 917.776.8346                 AIM: gedaliap
http://www.gedalia.net
---------------------------------------------------------------
Fight Entropy!!!  Fight Entropy!!!  Figth Etnropy! !
iFgth Etnrop!y ! giFth tErno!py !  giFt htrEno!p y! --- Well maybe
not...