Crear anotaciones de Javadoc personalizadas con taglets

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

package io.github.picodotdev.blogbitix.javadoc;

import com.sun.tools.doclets.Taglet;
import com.sun.javadoc.Tag;
import java.util.Map;

/**
 * A sample Taglet representing @todo. This tag can be used in any kind of
 * {@link com.sun.javadoc.Doc}.  It is not an inline tag. The text is displayed
 * in yellow to remind the developer to perform a task. For
 * example, "@todo Fix this!" would be shown as.
 *
 * @author picodotdev
 */
public class TodoTaglet implements Taglet {

    private static final String NAME = "todo";
    private static final String HEADER = "To do:";

    public String getName() {
        return NAME;
    }

    public boolean inField() {
        return true;
    }

    public boolean inConstructor() {
        return true;
    }

    public boolean inMethod() {
        return true;
    }

    public boolean inOverview() {
        return true;
    }

    public boolean inPackage() {
        return true;
    }

    public boolean inType() {
        return true;
    }

    public boolean isInlineTag() {
        return false;
    }

    public static void register(Map tagletMap) {
       TodoTaglet tag = new TodoTaglet();
       Taglet t = (Taglet) tagletMap.get(tag.getName());
       if (t != null) {
           tagletMap.remove(tag.getName());
       }
       tagletMap.put(tag.getName(), tag);
    }

    public String toString(Tag tag) {
        return "<b>" + HEADER + "</b><span style=\"background-color: yellow;\">" + tag.text() + "</span>\n";
    }

    public String toString(Tag[] tags) {
        if (tags.length == 0) {
            return null;
        }

        String result = "<b>" + HEADER + "</b><ul>" ;
        for (Tag tag : tags) {
            result += "<li><span style=\"background-color: yellow;\">" + tag.text() + "</span></li>";
        }
	result += "</ul>";
        return result;
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

package io.github.picodotdev.blogbitix.javadoc;

/**
 * Clase main de la aplicación.
 *
 * @see <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html">Javadoc</a>
 * @see <a href="https://docs.oracle.com/javase/8/docs/api/">Javadoc JDK</a>
 * @author picodotdev
 * @version 1.0
 *
 * @todo <span style="text-decoration: line-through;">Implementar in taglet personalizado</span>
 * @todo Añadir estilos al javadoc
 */
public class Main {

    /**
     * Método que imprime un mensaje.
     * 
     * @param args Argumentos del programa
     *
     */
    public static void main(String[] args) {
      System.out.println("Hola mundo");
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

apply plugin: 'java'
apply plugin: 'application'

sourceCompatibility = 1.8
targetCompatibility = 1.8

mainClassName = 'io.github.picodotdev.blogbitix.javadoc.Main'

repositories {
    jcenter()
}

dependencies {
    compile files("/usr/lib/jvm/default/lib/tools.jar")
}

javadoc {
    options.charSet = 'UTF-8'
    options.encoding = 'UTF-8'
    options.tagletPath = [new File ('build/classes/java/main/')]
    options.taglets = ['io.github.picodotdev.blogbitix.javadoc.TodoTaglet']
}

task javadocZip(type: Zip) {
    dependsOn javadoc
    classifier 'javadoc'
    from 'build/docs/javadoc/'
}

artifacts {
    archives javadocZip
}