Package com.google.gag.annotation.remark

Annotation Type RTFM

  • @Documented
@Retention(RUNTIME)
@Visionary("andy.tokarev")
public @interface RTFM
    Indicates that the author of the annotated code is strongly encouraged to read the manual at the specified URL. For example: 
       @RTFM("http://java.sun.com/javase/6/docs/api/java/lang/String.html")
   private static String stripPeriods(String s) {
     return s.replaceAll(".", "");
   }

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String value  

    • Element Detail

      • value

        java.lang.String value
        Default:
        ""