Bug 148906 - Support -Xlintfile for ajdoc
Summary: Support -Xlintfile for ajdoc
Status: RESOLVED FIXED
Alias: None
Product: AspectJ
Classification: Tools
Component: AJDoc (show other bugs)
Version: DEVELOPMENT   Edit
Hardware: PC Windows XP
: P3 minor (vote)
Target Milestone: 1.5.3   Edit
Assignee: Helen Beeken CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-06-27 18:33 EDT by Ron Bodkin CLA
Modified: 2012-04-03 16:05 EDT (History)
0 users

See Also:


Attachments
fix and tests (9.68 KB, application/zip)
2006-10-16 06:05 EDT, Helen Beeken CLA
no flags Details
patch synchronized with HEAD (21.41 KB, patch)
2006-10-23 08:08 EDT, Helen Beeken CLA
aclement: iplog+
Details | Diff
patch containing documentation update (4.24 KB, patch)
2006-10-25 05:13 EDT, Helen Beeken CLA
aclement: iplog+
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Ron Bodkin CLA 2006-06-27 18:33:55 EDT
It would be helpful for ajdoc to be able to parse valid AspectJ code with the same options that are usually used to compile it. High on that list would be support for -Xlintfile. This is an issue for the command line tool and the AJDT support both.
Comment 1 Helen Beeken CLA 2006-10-11 12:07:24 EDT
I think it makes sense for the usage of ajdoc to change from:

   ajdoc <options> <source files>

to be

   ajdoc <options> <source files> <ajc options>

Any option that doesn't fit as an "option" or "source file" would then be passed down to the compiler for it to resolve. If the option is invalid then the compiler would return with an error and ajdoc would report both this error and the fact that the compile failed.

I guess a slight alternative is to add something like:

   ajdoc <options> <source files> -ajc <ajc options>

and assume that everything after the "-ajc" is meant for the compiler...That way if there's something bogus before the "-ajc" you would get the ajdoc usage message.
Comment 2 Helen Beeken CLA 2006-10-16 06:05:42 EDT
Created attachment 52020 [details]
fix and tests

The attached zip file contains the following:

* pr148906-ajdoc.txt: apply to the ajdoc project (contains tests and fix)
* simple.jar: place in the ajdoc\testdata\pr148906 directory

The patch includes the patches supplied as part of bug 160302 and bug 160496. With this patch applied the ajdoc usage is now:

-----------------------------------------------------------------

Usage: ajdoc <options> <source files>

where <options> includes:
  -public                   Show only public classes and members
  -protected                Show protected/public classes and members
  -package                  Show package/protected/public classes and members
  -private                  Show all classes and members
  -help                     Display command line options
  -sourcepath <pathlist>    Specify where to find source files
  -classpath <pathlist>     Specify where to find user class files
  -bootclasspath <pathlist> Override location of class files loaded
  -d <directory>            Destination directory for output files
  -argfile <file>           Build config file (wildcards not supported)
  -verbose                  Output messages about what Javadoc is doing
  -v                        Print out the version of ajdoc
  -source <version>         set source level (1.3, 1.4 or 1.5)

as well as the AspectJ Compiler options.

If an argument is of the form @<filename>, the file will be interpreted as
a line delimited set of arguments to insert into the argument list.
--------------------------------------------------------------------
Comment 3 Helen Beeken CLA 2006-10-23 08:08:57 EDT
Created attachment 52509 [details]
patch synchronized with HEAD

Apply this patch to the ajdoc project.

Use the simple.jar for the tests that was in the previously attached zip file.
Comment 4 Andrew Clement CLA 2006-10-23 08:45:21 EDT
patches in
Comment 5 Helen Beeken CLA 2006-10-24 03:50:57 EDT
The final piece of work for this bug (on the AJ side) is to update the docs http://www.eclipse.org/aspectj/doc/released/devguide/rn01re02.html to reflect the fact that ajdoc now honours aj options.
Comment 6 Helen Beeken CLA 2006-10-25 05:13:21 EDT
Created attachment 52655 [details]
patch containing documentation update

Apply this patch to the docs project.

This updates the ajdoc documentation to include the fact that you can now pass aspectj options to ajdoc. Also, it removes the "known limitations" section and references to ajdoc not displaying crosscutting info from declare statements and itds (this was fixed in bug 121711).
Comment 7 Andrew Clement CLA 2006-10-25 05:20:24 EDT
patch in
Comment 8 Helen Beeken CLA 2006-10-25 06:21:26 EDT
bug 162185 has been raised to cover enabling the passing of aj options to ajdoc within AJDT
Comment 9 Helen Beeken CLA 2006-10-25 09:09:18 EDT
fix available in latest aspectj dev build.

iplog