2016-10-21 17 views
4

私はJavadocが示すすべてのエラーと警告を修正してプロジェクトのjavadocで作業しています。しかし、それらのほとんどを修正した後、私が想像することができない何らかの理由。パッケージの生成中にJavadocの警告が表示される

4 warnings 
[WARNING] Javadoc Warnings 
[WARNING] C:\Users\magno\Documents\Globalmentor\Globalmentor's work\marmot\src\main\java\com\globalmentor\marmot\MarmotSession.java:100: warning - Tag @see: can't find getResourceKit(Repository, URFResource, Capability...) in com.globalmentor.marmot.MarmotSession 
[WARNING] C:\Users\magno\Documents\Globalmentor\Globalmentor's work\marmot\src\main\java\com\globalmentor\marmot\MarmotSession.java:140: warning - Tag @see: can't find getResourceKit(Repository, URFResource, Capability...) in com.globalmentor.marmot.MarmotSession 
[WARNING] C:\Users\magno\Documents\Globalmentor\Globalmentor's work\marmot\src\main\java\com\globalmentor\marmot\MarmotSession.java:166: warning - Tag @link: can't find getResourceKit(Repository, URFResource, Capability...) in com.globalmentor.marmot.MarmotSession 
[WARNING] C:\Users\magno\Documents\Globalmentor\Globalmentor's work\marmot\src\main\java\com\globalmentor\marmot\MarmotSession.java:140: warning - Tag @link: can't find getResourceKit(Repository, URFResource, Capability...) in com.globalmentor.marmot.MarmotSession 
[INFO] Building jar: C:\Users\magno\Documents\Globalmentor\Globalmentor's work\marmot\target\marmot-0.5.1-SNAPSHOT-javadoc.jar 
[INFO] ------------------------------------------------------------------------ 
[INFO] BUILD SUCCESS 
[INFO] ------------------------------------------------------------------------ 
[INFO] Total time: 33.921 s 
[INFO] Finished at: 2016-10-21T10:03:11-02:00 
[INFO] Final Memory: 29M/412M 
[INFO] ------------------------------------------------------------------------ 

問題がある:私は参照を書き始めるとき、これらの参照は、メソッドと同じクラスであり、さらにはEclipseがそれらを示唆して、誰もが私にこの警告を与えることができる何かを知っているのですか?

/** 
* Determines if there exists resource kit appropriate for the given resource supporting the given capabilities. 
* @param repository The repository in which the resource resides. 
* @param resource The resource for which a resource kit should be returned. 
* @param capabilities The capabilities required for the resource kit. 
* @return <code>true</code> if there exists a resource kit to handle the given resource with the given capabilities, if any, in relation to the resource. 
* @see #getResourceKit(Repository, URFResource, Capability...) 
*/ 
public boolean hasResourceKit(final Repository repository, final URFResource resource, final Capability... capabilities); 

/** 
* Retrieves a resource kit appropriate for the given resource statically if possible, without further resource lookup. This method locates a resource kit in 
* the following priority: 
* <p> 
* The first resource kit supporting the resource content type determined by: 
* </p> 
* <ol> 
* <li>The given content type, if any.</li> 
* <li>The content determined if possible by {@link #getExtensionContentType(String)} from the resource URI extension.</li> 
* <li>The resource description is retrieved as a last resort and the resource kit is determined by delegating to 
* {@link #getResourceKit(Repository, URFResource, Capability...)}.</li> 
* </ol> 
* @param repository The repository in which the resource resides. 
* @param resourceURI The URI of the resource in the given repository. 
* @param contentType The type of content the resource contains, or <code>null</code> if unknown. 
* @param capabilities The capabilities required for the resource kit. 
* @return A resource kit to handle the given resource with the given capabilities, if any, in relation to the resource; or <code>null</code> if there is no 
*   registered resource kit with the given capabilities in relation to the resource. 
* @throws ResourceIOException if an error occurred retrieving a description of the resource kit. 
* @see #getResourceKit(Repository, URFResource, Capability...) 
*/ 
public RK getResourceKit(final Repository repository, final URI resourceURI, final ContentType contentType, final Capability... capabilities) 
     throws ResourceIOException; 

/** 
* Retrieves a resource kit appropriate for a MIME content type. This method should only be used for special-purpose functionality; when accessing resources 
* {@link #getResourceKit(Repository, URFResource, Capability...)} should normally be used instead. 
* @param contentType The type of content the resource contains. 
* @param capabilities The capabilities required for the resource kit. 
* @return A resource kit with the requested capabilities to handle the given content type, or <code>null</code> if no appropriate resource kit is registered. 
*/ 
public RK getResourceKit(final ContentType contentType, final Capability... capabilities); 

そして、ここではそれは同じクラスからです、上記のJavadocで参照されています方法は次のとおりです:

/** 
* Retrieves a resource kit appropriate for the given resource. This method locates a resource kit in the following priority: 
* <ol> 
* <li>The first resource kit supporting the resource content type determined by {@link #determineContentType(URFResource)}.</li> 
* <li>The first resource kit supporting one of the resource types.</li> 
* <li>If the resource has a collection URI, the default collection resource kit.</li> 
* <li>The default resource kit.</li> 
* </ol> 
* @param repository The repository in which the resource resides. 
* @param resource The resource for which a resource kit should be returned. 
* @param capabilities The capabilities required for the resource kit. 
* @return A resource kit to handle the given resource with the given capabilities, if any, in relation to the resource; or <code>null</code> if there is no 
*   registered resource kit with the given capabilities in relation to the resource. 
* @see #determineContentType(URFResource) 
*/ 
public RK getResourceKit(final Repository repository, final URFResource resource, final Capability... capabilities); 

ので、ここで

は警告を示しているのJavadocプロジェクトは公開されています。javadocsを修正するために行ったことのプルリクエストのリンクは次のとおりです。Bitbucket - Globalmentor's Project: MARMOT-5

答えて

4
あなたの問題は、実際に Capability静的内部クラスであるという事実に関係している

、多くはあなたがResourceKitでその外側のクラスを前に付けなければならない。この問題を回避するために、内部クラスとjavadocツールに問題が知っていますあなたの場合。

だから、単に私はreallこの

@see #getResourceKit(Repository, URFResource, ResourceKit.Capability...) 

この

{@link #getResourceKit(Repository, URFResource, ResourceKit.Capability...)} 
+1

この

{@link #getResourceKit(Repository, URFResource, Capability...)} 

この

@see #getResourceKit(Repository, URFResource, Capability...) 

を置き換えますそれは方法についてだけだと思った、私に指摘してくれてありがとう、それは私の将来のような他の状況に役立ちます。 –