Oct 22

Asdoc ant task

ActionScript, Flex Add comments

I just created an Ant task to build Asdoc documentation files.

For this first version, the following attributes are supported:

  • docSources: the directory with actionscript classes or packages
  • windowTitle: title of the html file
  • mainTitle: title in the top frame
  • footer: footer text
  • leftFramesetWidth: width in pixels of the left frameset
  • output: the output directory
  • executable: the path to the asdoc executable; leave this out if you have asdoc.exe in your PATH

In order to use it, follow these steps:

  1. Download the asdoc ant task here
  2. Unzip the file and copy the asdoc-ant.jar file to your project directory
  3. Define the task in your build.xml file (see below)
  4. Add a target with a call to the asdoc task (see below)
  5. Run the target

Here's a complete example of a build file:

PLAIN TEXT
XML:
  1. <project name="Sample project" basedir=".">
  2.   <taskdef name="asdoc" classpath="${basedir}/asdoc-ant.jar" classname="org.pranaframework.ant.Asdoc"/>
  3.   <target name="docs">
  4.     <asdoc
  5.       docSources="src"
  6.       windowTitle="My Project API Documentation"
  7.       mainTitle="My Project"
  8.       footer="Copyright 2007 - My Company"
  9.       leftFramesetWidth="200"
  10.       output="${basedir}/api"/>
  11.   </target>
  12. </project>

Feel free to contact me at info[AT]herrodius.com or leave a comment here if you find any bugs or have a feature request. The sources for this task will be added to the Prana SVN repository.

Add to Bloglines - Digg This! - del.icio.us - Stumble It! - Twit This! - Technorati links - Share on Facebook - Feedburner
 

7 Responses to “Asdoc ant task”

  1. Chris Brown Says:
    March 14th, 2008 at 6:46 am

    Thanks for sharing

  2. Trevor Burton Says:
    July 3rd, 2008 at 1:33 pm

    Christophe - is there any way to load a custom flex-config file?

  3. Beau Scott Says:
    July 17th, 2008 at 4:33 pm

    Any chance of getting the source to this? I couldn’t find it in the Prana repository, and I’d like to add the support of custom flex-config files (the load-config parameter of asdoc)

    Beau

  4. Christophe Says:
    July 17th, 2008 at 7:17 pm

    Hi Beau,

    the sources are available in the old repo structure. Please see http://prana.svn.sourceforge.net/viewvc/prana/trunk/ant/ or check out the repo. We still need to merge some parts of that old structure with the new one. Let me know if you would be interested in having svn commit access.

    @Trevor: a little late… I hope Beau can provide you with that option ;-)

  5. JP Says:
    July 22nd, 2008 at 10:40 pm

    Is it possible to exclude some filesets? For example, I want to exclude all files within SCCS (BitKeeper source control) dirs.

  6. Matthew Lloyd Says:
    August 19th, 2008 at 3:23 pm

    This is really great thanks Chrisophe,

    However it would be nice if we could have an exclude regex, failing that
    multiple doc sources would be nice!

  7. Matthew Lloyd Says:
    August 19th, 2008 at 3:29 pm

    Actually I’ve just got hold of the source, I’ll add the changes myself and
    place it on my blog, with accreditation to you obviously.

Leave a Reply

WP Theme & Icons by N.Design Studio
Entries RSS Comments RSS Login