Easy-to-fix javadoc warning

Chris Hegarty chris.hegarty at oracle.com
Mon Feb 13 03:12:56 PST 2012


Thanks for reporting this Jon.

I filed CR 7145043: "HttpServerProvider.java:81: warning - 
@code("httpServerProvider") is an unknown tag"

You see quite a few of these type of RuntimePermission links through out 
the core area. The intent is to link to RuntimePermission and show the 
appropriate String arg "target name".

The simplest fix is to add a space after the @code tag. This generates 
the required javadoc, "RuntimePermission("httpServerProvider")", similar 
to how it appears in System.getenv [1].

src/share/classes/com/sun/net/httpserver/spi/HttpServerProvider.java
@@ -76,7 +76,7 @@ public abstract class HttpServerProvider
       *
       * @throws  SecurityException
       *          If a security manager has been installed and it denies
-     *          {@link RuntimePermission}{@code("httpServerProvider")}
+     *          {@link RuntimePermission}{@code ("httpServerProvider")}
       */
      protected HttpServerProvider() {
          SecurityManager sm = System.getSecurityManager();


Thanks,
-Chris.

[1] 
http://download.java.net/jdk8/docs/api/java/lang/System.html#getenv%28java.lang.String%29



More information about the net-dev mailing list