as2api is great. Believe it or not, Doxygen also works well, and can generate UML from your code. Search the Flashcoders archives, there was a thread on this in the last month.
Jim Kremens On 10/3/05, David Holroyd <[EMAIL PROTECTED]> wrote: > Hi there, > > On Sun, Oct 02, 2005 at 10:53:58PM -0400, Austin Haas wrote: > > Has anyone considered using DocBook? It's on my todo list. You can > > publish to a variety of formats. It seems to be very widespread. > > > > http://www.docbook.org/ > > DocBook is great for authoring technical documentation. I use it to > generate the documentation for as2api: > > http://www.badgers-in-foil.co.uk/projects/as2api/as2api-documentation.html > > The source code for that documentation looks like this: > > > http://svn.badgers-in-foil.co.uk/as2api/trunk/as2api/as2api-documentation.xml > > > > The biggest obstacle is that it doesn't know anything about > > Actionscript. You would have to use a separate parser to generate the > > xml that it understands. > > Sounds like you're after an analogue of the DBDoclet for JavaDoc: > > http://www.michael-a-fuchs.de/ > > I've thought about such a feature for as2api, and while I'll probably > not have the time to implement it myself, I accept patches ;) > > > > One of my personal requirements is that you shouldn't have to add > > special comments or have a rigid style in order to generate > > documentation. I don't want to change the way I code to support a doc > > generator, and I'd like to be able to generate docs from someone else's > > code. > > as2api uses JavaDoc syntax, and JavaDoc syntax is certainly a bit odd; > but hey, it's a standard! > > If you point as2api at code annotated differently (or not at all), it > should still produce *something*, as most of the structure is derived > from the structure of the AS code. The more you put in, the more you > get out. > > > dave > > -- > http://david.holroyd.me.uk/ > > _______________________________________________ > osflash mailing list > [email protected] > http://osflash.org/mailman/listinfo/osflash_osflash.org > _______________________________________________ osflash mailing list [email protected] http://osflash.org/mailman/listinfo/osflash_osflash.org
