RE: [aspectj-dev] ajdoc update

["Mik Kersten" <beatmik@xxxxxxxxx>]

Based on Ron's feedback from running ajdoc on aTrack I've made the following
enhancements and a bug fix for dealing with declare forms.  Ron: please
Bugzilla so that this stuff gets recorded.  All: use the new -XajdocDebug
flag to send offending generated source files along with bug reports.

- Added support for 1.4 sources (use "-source 1.4" option)

- Made output class files go to documentation directory (-d) rather than
source directory.

- Added "-XajdocDebug" option that will keep the source files generated from
the ASM around in order to help people send better bug reports.

- Any declare forms that ajdoc doesn't know how to generate docs for get
printed to the console and indicated as a limitation.

I also extended test coverage to declare forms and added proper clearing of
state for multiple invocations from test cases.

Mik

> -----Original Message-----
> From: aspectj-dev-admin@xxxxxxxxxxx [mailto:aspectj-dev-admin@xxxxxxxxxxx]
> On Behalf Of Mik Kersten
> Sent: Tuesday, April 06, 2004 9:20 PM
> To: aspectj-dev@xxxxxxxxxxx
> Subject: [aspectj-dev] ajdoc update
> 
> I just committed the updates to ajdoc needed for 1.2.  In a nutshell it's
> moved forward a ways from the previous ajdoc:
> - AJDT integration works
> - generates documentation for all the AspectJ modules
> - works on 1.3 and 1.4
> - comments and Javadoc tags are properly preserved and resolved
> 
> Note that the hope is still for "declare" documentation to come in the
> form
> of a contribution.
> 
> Getting it to work for our tree involved a bunch of bug fixes to deal with
> things like anonymous types.  To run from our tree in bootstrap mode use
> something like the attached batch script.  To run from AJDT point Eclipse
> at
> this command under the "Project -> Generate Javadoc" menu.  End users will
> be able to point at the "<aj-install-dir>/bin/ajdoc.bat".
> 
> I had to roll back some of Andy's fix to broken links:
> getRelativeComponent
> didn't work properly for internal anchor links (..html#<mumble>).  Andy,
> could you check this against the current thing against whatever was
> breaking
> for you, and ideally add that code patter to CoverageTestCase?
> 
> I added -XjavadocsInModel to make the addition of Javadoc strings to the
> ASM
> only happen when request it (prevent bloat of the model with strings.  The
> running time of ajdoc is now dominated by the compilation time.
> 
> I had to make a change to a test case that I'm not quite comfortable with.
> AsmBuilderTest.testNullHandlingOfVisit() now checks for an NPE instead of
> an
> EmptyStackException.  I'm not sure how the original could have worked in
> the
> absence of the handle cache.
> 
> Mik
> 
> --
> http://kerstens.org/mik