Today I decided to update to flex 4. After installing version 220.127.116.1176 I ran asdoc to see if the comments in my action script library still were ok. Things had changed though, as I discovered. Below I describe my experience and solution.
Since I’m sending out my library with various project sources I have included a standard header that includes author, website, copyright, version, etc. information. Since there were no comment tags for those, I used some HTML formatting to get a style similar to the rest of the generated documentation.
However after running asdoc from flex 4, part of this formatting had disappeared. The various <br/> tags I used had been filtered out; asdoc also removed style attributes I used within some <span> tags.
Not being a xslt guru and not really wanting to dive into over 300kb of almost completely undocumented xslt code I looked around the internet for a solution.
First I came across asdoc-enhancements. Originally intended for flex 3, I managed to get it working with flex 4. I looked in the downloaded class-files.xslt and then copied the warning code to the new class-files.xslt. I only had to change
I added a @warning to both my class comment as well to a method comment. After running asdoc, the generated html got a nice red Warning text line at both comments.
So I decided to try to add another custom tag. But this did not work out completely as expected, although the new tag was shown; the @warning tag no longer produced a red Warning text line.
So I looked at the generated xml files (using the
-keep-xml option). In some of the generated xml files the warning tag had disappeared. After some digging around, I found the java source at TopLevelClassesGenerator.java. It turns out the method
processCustoms() only stores the last custom tag it comes across; instead of storing all.
So it seems you can have a custom tag, but only one 🙁
However not all was lost, it is still possible to use xml tags as value for the custom tag. These will appear as child elements of the custom tag element in the generated xml files.
So instead of various custom tags I defined a single custom tag (@ultraforce), with various xml tags as value. And then alter the class-files.xslt to transform those into formatted HTML.
Here is how it looks inside an .as file:
/** * ... * @ultraforce * <author email="josha_at_ultraforce.com">J. Munnik</author> * <website>www.ultraforce.com</website> * <copyright>Copyright (c) 2008 by Ultra Force Development</copyright>
And this is what I added to the end of
<xls:template name="description"> in the class-files.xslt (this is my first try at xslt programming, so don’t expect to much):
<xsl:if test="prolog/asCustoms/ultraforce/author"> <p><b>Author</b><br/><xsl:value-of select="prolog/asCustoms/ultraforce/author/." /> <xsl:if test="prolog/asCustoms/ultraforce/author/@email"> <xsl:variable name="email" select="replace(prolog/asCustoms/ultraforce/author/@email, '_at_', '@')" /> <xsl:value-of disable-output-escaping="yes" select="concat(' (<a href="mailto:',$email,'" target="_blank">',$email,'</a>)')"/> </xsl:if> </p> </xsl:if> <xsl:if test="prolog/asCustoms/ultraforce/website"> <xsl:variable name="website" select="prolog/asCustoms/ultraforce/website/." /> <p><b>Website</b><br/> <xsl:value-of disable-output-escaping="yes" select="concat('<a href="http://',$website,'" target="_blank">',$website,'</a>')"/> </p> </xsl:if> <xsl:if test="prolog/asCustoms/ultraforce/copyright"> <p><b>Copyright</b><br/> <xsl:value-of disable-output-escaping="yes" select="replace(prolog/asCustoms/ultraforce/copyright/., '\(c\)', '&copy;')" /> </p> </xsl:if>
After asdoc, the extra information is formatted correct again. And I have to admit this new way of specifying information is at least more readable in the source then the previous one using HTML formatting.
Still, to bad asdoc does not support multiple custom tags or even better yet, defines various new tags. But who knows, maybe in the future things might change…
Note: it seems the @author tag is supported by the java code and results in a separate element in the generated xml files. So one only has to add a transformation to class-files.xslt to make it visible.