Javadoc displaying value on an inner class constant using @value

18,822

Solution 1

Javadoc format for constant defined in another package should be:
{@value package.class#field}

However, it potentially not rendering is a known issue:
https://bugs.eclipse.org/bugs/show_bug.cgi?id=342194

Solution 2

if create javadoc for members with visibility "package" (which is the visibility for your Bar class) i get the constant in the javadoc under Foo.Bar

Share:
18,822
eold
Author by

eold

Updated on July 22, 2022

Comments

  • eold
    eold almost 2 years

    I have an inner class which declares a constant and want to display its value in Javadoc of the enclosing top-level class using the @value annotation. For example:

    /**
     * {@value #FOO_CONS} // this displays well
     * {@value #BAR_CONS} // this does not work (checked in the latest Eclipse)
     * {@value Bar#BAR_CONS} // this does not work, either
     */
    public Foo {
      public static final int FOO_CONS = 1;
      static class Bar {
        public static final int BAR_CONS = 42;
      }
    }
    

    Any ideas how to display the value of BAR_CONS in Javadoc of the Foo class (or any other class, in general)?