Как создать HTML-страницы Javadoc, которые включают в себя некоторые помеченные классы и члены класса? - PullRequest
Новая
       13

Как создать HTML-страницы Javadoc, которые включают в себя некоторые помеченные классы и члены класса?

0 голосов
/ 23 мая 2019

Мне нужно создать javadoc для моего проекта, в котором я должен учитывать только те классы, у которых есть тег " @ accept " и члены класса с тегом " @ ignore "не следует рассматривать, чтобы показать на сгенерированной странице HTML Javadoc.

Вышеупомянутое должно быть сделано с использованием JDK8 .

Рассмотрим классы A, B и C, приведенные ниже.

A.java

/**
 * @accept
 */
public class A {


    String field1;

    /**
     * @ignore
     */
    String field2;

    public A(String field1) {
        this.field1 = field1;
    }

    /**
     * @ignore
     */
    public A(String field1, String field2) {
        this.field1 = field1;
        this.field2 = field2;
    }

    public void setField1(String field1) {
        this.field1 = field1;
    }

    /**
     * @ignore
     */
    public void setField2(String field2) {
        this.field2 = field2;
    }

}

B.java 

public class B {

    // Fields and methods here...

}

C.java 

/**
 * @accept
 */
public class C {

    String field1;

    String field2;

    public C(String field1, String field2) {
        this.field1 = field1;
        this.field2 = field2;
    }

}

Когда я создаю javadoc html для вышеуказанногоклассы, выходные данные должны содержать следующее. 

Class A  
- String field1; // field  
- public A(String field1); // constructor  
- public void setField1(String field1); // method  

Class C  
- String field1; // field  
- String field2; // field  
- public C(String field1, String field2); // constructor

В приведенном выше ожидаемом выводе мы не видим класс B, поскольку у него нет тега @accept.

Для класса A мы не вводим поле field2 , конструктор A (String field1, String field2) и метод public void setField2 (Строка field2) , поскольку они содержат тег @ignore.

...