[as2api-dev] Re: [osflash] [ANN] as2api 0.4 released

[David Holroyd]

Hi again,

On Thu, Feb 09, 2006 at 09:30:15PM +0800, iiley wrote:
> as2api seem has problem to generate link to this:
> 
> /**
>  * @see FocusManager#setDefaultFocusTraversalPolicy()
>  * @see FocusManager#getDefaultFocusTraversalPolicy()
>  */
> 
> But @Container#someMethod() generated fined. (FocusManager is at the
> same package)

I grabbed the source from svn, and the significant parts of the file in
question are:


----8<----
...

import org.aswing.Component;
import org.aswing.Container;
import org.aswing.JWindow;

/**
 ...
 * @see Container#isFocusTraversalPolicyProvider()
 * @see FocusManager#setDefaultFocusTraversalPolicy()
 * @see FocusManager#getDefaultFocusTraversalPolicy()
 ...
*/
interface org.aswing.FocusTraversalPolicy {
    ...
---->8----

The generated documentation doesn't include the expected links to
FocusManager methods, while the links to methods of Container are fine.
This is because (contradicting my earlier statement ;) types in the same
package as the current type are *not* automatically in scope.

i.e., in order for as2api to know what type 'FocusManager' refers to in
the comment, you need to either 'import' it, or use the fully-qualified
name 'org.aswing.FocusManager'.

(I would suggest you go with the latter option.)


hope that helps,
dave

-- 
http://david.holroyd.me.uk/