Search code examples
javaintellij-ideadocumentationjavadoc

Using @value in javadoc with a data.properties file


I'm using Javadoc for documentation. Currently I have something that looks like this

/**
* Test Doco
*
*/
public class testClass() {
    public void testMethod() {
        /** More test doco
        */

        customFunction() 
    }
}

I also have a data.properties file that is pretty straight forward:

basic.entry=test
second.entry=test2
third.entry=test3

I was wondering if there was a way to link my Javadoc to pull a value out of the data.properties file?

I have tried:

/** 
* {@value /properties/data.properties#basic.entry)
*/

Solution

  • Neither JavaDoc specification nor IntelliJ IDEA support values from external files.