2016-10-21 3 views
4

Ich arbeite an den Javadocs eines Projekts und behebe alle Fehler und Warnungen, die Javadoc zeigt. Aber nachdem ich die meisten von ihnen repariert habe, gibt es genau diesen, der angezeigt wird ein Grund, den ich mir nicht vorstellen kann.Javadoc Warnung wird beim Generieren des Pakets angezeigt

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] ------------------------------------------------------------------------ 

Das Problem ist: Diese Referenzen sind auf der gleichen Klasse als die Methode, und sogar von Eclipse schlägt sie, wenn ich die Referenzen dem Schreiben beginnen, weiß jemand etwas anderes, das mir diese Warnung geben könnte? Hier

ist die javadocs, dass die Warnung zeigt:

/** 
* 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); 

Und hier ist die Methode, die oben in der javadocs verwiesen ist abgesehen, ist es aus der gleichen Klasse:

/** 
* 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); 

Seit Das Projekt ist öffentlich, hier ist ein Link für die Pull-Anfrage, was ich getan habe, um die Javadocs zu reparieren: Bitbucket - Globalmentor's Project: MARMOT-5

Antwort

4

Ihr Problem ist eigentlich auf die Tatsache, dass Capability eine statische innere Klasse ist gibt es Probleme in der javadoc-Tool mit inneren Klassen, viele kennen dieses Problem zu umgehen, sollten Sie Präfix es mit seiner äußeren Klasse die ResourceKit ist in Ihrem Fall.

So einfach diese

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

mit diesem

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

ersetzen und diese

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

mit diesem

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

I reall Ich dachte, es ginge nur um die Methode, danke, dass Sie mich darauf hingewiesen haben, das wird mir in Zukunft in anderen Situationen helfen. –

Verwandte Themen