Discussion :

[mortalius]

Bonjour,bonsoir,

Je cherche a completer ma javadoc de mon projet.

J'ai dans ce projet un package.Et je souhaite dans la doc afficher un peu comme sur le site de sun, en haut a gauche, le paquetage...

Mais voilà, je ne trouve pas comment faire ?

QQ1 peut m'aider?

Merci

[bouye]

Mais euh, c'est le comportement par defaut...

Sinon moi j'utilise un fichier MakeDoc.bat contenant les lignes suivantes (pas tres complique d'en faire un equivalent Linux/UNIX) :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
 
@ECHO OFF
cls
rmdir /s /q .\doc
mkdir doc
javac -cp . JavadocRecurse.java
java -cp . JavadocRecurse packages.txt src
javadoc -J-Xmx512m -locale en -protected -author -version -use -splitindex -windowtitle "Java programming documentation" -bottom "<A HREF=\"http://www.spc.int/\">Secretariat of the Pacific Community</A>" -header "SPC - Secretariat of the Pacific Comunity." -footer "This is the java documentation for SPC libraries." -classpath . -sourcepath src -d doc @packages.txt

Accompagne de la classe suivante (que Sun avait envoye dans un de ses courrier d'info/programming tips je crois) :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

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
 
import java.io.PrintWriter;
import java.io.BufferedWriter;
import java.io.FileWriter;
import java.io.IOException;
import java.io.File;
 
public class JavadocRecurse {
    static PrintWriter writer;
 
    public static void main(String[] args) {
 
        if (args.length < 2) {
            System.out.println("First command line argument is the destination file");
            System.out.println("where the package names will be stored");
            System.out.println("Rest of the arguments are directory paths to the packages");
            System.out.println("Example:");
            System.out.println(
                "java JavadocRecurse packages.txt rootdir1 rootdir2 rootdirN");
            return;
        }
 
        try {
            writer = new PrintWriter(new BufferedWriter(new FileWriter(args[0])));
            for (int i=1; i<args.length; i++) {
                File root = new File(args[i]);
                if (root.isDirectory()) {
                    writeDirs(root, root);    
                }
            }
            writer.close();
        } catch (IOException ex) {
            ex.printStackTrace();
        }
    }
 
    private static void writeDirs(File root, File dir) {
        String files[] = dir.list();
        boolean fileFound = true;
        for (int i=0; i<files.length; i++) {
            File file = new File(dir,files[i]);
            if (file.isDirectory()) {            
                writeDirs(root,file);            
            } else if (fileFound && (files[i].endsWith(".class")
 
                    || files[i].endsWith(".java"))) {
                fileFound = false;
                if (root.equals(dir)) {
                    //writer.println(".");   This was incorrect assumption about Javadoc
                } else {
 
writer.println(dir.getPath().substring(root.getPath().length()+1).replace(File.separatorChar,'.'));                
                }
            }
        }
    }
}

Cette classe va lister toutes les sources de tous les packages et les mettre dans un fichier package.txt. Javadoc (comme beaucoup de commandes java) prend l'argument @<nomdefichier> ou <nomdefichier> est le nom d'un fichier texte listant des fichiers sources .java.

Mais bon c'est assez rare que je regenere la doc ces temps ci, l'API est devenue trop grosse, ca prend des plombes... J'utilise plutot le generateur automatique de page de doc de JBuilder.

[mortalius]

Merci, je vais regarder a cela ...

[xavlours]

D'habitude, la javadoc est générée telle que sur le site de Sun. Es tu sur d'ouvrir la page index.html et pas la page de ta classe directement ?

[mortalius]

oui, je suis certain...

C'est comme les pages de sun, mais a gauche, j'ai juste la liste des classes, mais pas la listes de mes packages. C'est peut etredut au fait que j'ai qu'un seul paquetage.

[bouye]

C'est bizarre, comme indique la liste des packages en haut a gauche c'est le comportement par defaut de javadoc.