Alluxio / Community

New Contributor Tasks for Alluxio
20 stars 38 forks source link

Fix the @see tag sequence in PropertyKey.isRemoved #592

Closed LuQQiu closed 3 years ago

LuQQiu commented 3 years ago

From the Java doc style that we follow https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html The @see tag sequence should be

@see #field
@see #Constructor(Type, Type...)
@see #Constructor(Type id, Type id...)
@see #method(Type, Type,...)
@see #method(Type id, Type, id...)
@see Class
@see Class#field
@see Class#Constructor(Type, Type...)
@see Class#Constructor(Type id, Type id)
@see Class#method(Type, Type,...)
@see Class#method(Type id, Type id,...)
@see package.Class
@see package.Class#field
@see package.Class#Constructor(Type, Type...)
@see package.Class#Constructor(Type id, Type id)
@see package.Class#method(Type, Type,...)
@see package.Class#method(Type id, Type, id)
@see package

Please help change the @see tag sequence in the PropertyKey.isRemoved method documentation to the correct order.

  /**
   * Returns whether or not a property key has been removed from use.
   *
   * If a PropertyKey or {@link Template} is deemed as "Removed" it will exist within
   * {@link RemovedKey}. This method can be used to detect if a key being utilized has been removed.
   *
   * @param key the property key to check
   * @return true this property key is removed, false otherwise
   * @see RemovedKey
   * @see #isDeprecated(alluxio.conf.PropertyKey)
   * @see Deprecated
   */
  public static boolean isRemoved(String key) {
    return RemovedKey.isRemoved(key);
  }