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 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 

package fr.koor.doclet;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Set;

import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.ElementKind;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.VariableElement;

import com.sun.source.doctree.DocCommentTree;
import com.sun.source.util.DocTrees;

import jdk.javadoc.doclet.Doclet;
import jdk.javadoc.doclet.DocletEnvironment;
import jdk.javadoc.doclet.Reporter;
 

/**
 * Un exemple simple de doclet.
 */
public class SimpleDoclet implements Doclet {
    
    /**
     * Le constructeur de notre Doclet.
     */
    public SimpleDoclet() {
        super();
    }
    
    /**
     * Méthode d'initialisation de la Doclet.
     */
    @Override
    public void init(Locale locale, Reporter reporter) {  
        System.out.println( ">>> Doclet is initialized" );
    }
 
    /**
     * Renvoie le nom de la Doclet (ici, le nom de la classe).
     */
    @Override
    public String getName() {
        return getClass().getSimpleName();
    }
 
    @Override
    public Set<? extends Option> getSupportedOptions() {
        System.out.println( ">>> In getSupportedOptions" );
        return Collections.emptySet();
    }
 
    @Override
    public SourceVersion getSupportedSourceVersion() {
        System.out.println( ">>> In getSupportedSourceVersion" );
        return SourceVersion.latest();
    }
     
 
    /**
     * Le point d'entrée de notre doclet de test.
     * 
     * @param environment Représente l'environnement de la Doclet.
     */
    @Override
    public boolean run(DocletEnvironment environment) {
        System.out.println( ">>> In getSupportedSourceVersion" );

        // Un arbre de noeuds de commentaires Javadoc
        DocTrees trees = environment.getDocTrees();
        
        // On parcourt l'arbre syntaxique du code analysé.
        for ( Element element : environment.getSpecifiedElements() ) {
            
            // On affiche le nom de la classe et sa documentation.
            DocCommentTree tree = trees.getDocCommentTree( element );
            System.out.printf( "Type %s : %s\n",
                               element.getSimpleName(),
                               tree != null ? tree.toString() : "" );
            
            // On parcourt tous les membres du type courant et 
            // on affiche un éventuel commentaire Javadoc.
            for( Element member : element.getEnclosedElements() ) {
                DocCommentTree memberTree = trees.getDocCommentTree( member );
                System.out.printf( "\t%s - %s - %s\n",
                                   member.toString(),
                                   member.getKind().toString(),
                                   memberTree != null ? memberTree.toString() : "" );
                
                // Si le membre est une méthode ou un constructeur, on liste les paramètres
                if ( Arrays.asList( ElementKind.METHOD, 
                                    ElementKind.CONSTRUCTOR ).contains( member.getKind() ) ) {
                    ExecutableElement methodElement = (ExecutableElement) member;
                    List<? extends VariableElement> parameters = methodElement.getParameters();
                    for (VariableElement parameter : parameters) {
                        System.out.printf( "\t\t%s - %s\n",
                                           parameter.getSimpleName(),
                                           parameter.asType().toString() );
                    }
                }
            }
        }
        
        return true; // Le traitement se termine correctement.
    }
        
}