[as2api-dev] Re: AS2API command line & GUI issues

[David Holroyd]

On Mon, Jul 11, 2005 at 09:44:29AM +0300, Armand Niculescu wrote:
> sorry to bother,

No trouble at all!

> I have some details of the problems I'm facing.
> 
> The directory structure is OK as far as I can tell, I have a screenshot, 
> the packages are in separate folders.

Yeah, from that screenshot, it appears as though the directory structure
is exactly as it should be.  I will try to prepare a version of as2api
that gives more feedback than just "No source files matching ..." to
help debug this.


> You'll also find a sample class file from the package as well as the 
> resulting documentation from the 0.2 GUI version.

The comments in the file you provided don't confirm to the format that
as2api expects.  Specifically,

 - @param documentation must name the parameter being documented, so
   rather than,
     @param  value to validate
   you need,
     @param  num  value to validate

 - Descriptions don't have a specific tag; just put the descriptive text
   at the very beginning of the comment, before anything else.  Rather
   than,
     /**
     ...
     @description Validate a number, with optional boundaries
     ...
   you need,
     /**
     Validate a number, with optional boundaries
     ...


This is based on the format used by JavaDoc.


dave