/**
*
* - But: Le but de ce programme est d'enseigner les techniques de documentation de code.
*
-
*
*
- Description:
*
- Le code ne fait absolument rien d'utile.
*
* Les objectifs de ce programme sont
* - d'amener les etudiants a comprendre javadoc
* - de convaince les etudiants que la documention c'est utile
*
*
*
* @author Etienne Bergeron
* @version 1.0
*
*/
public class JavadocDemo {
/**
* Contient une valeur bidon.
*/
public static int field1;
/**
* Contient une valeur utile.
*/
public static int field2;
/**
* Constructeur du Demo.
* @param n Nombre d'etudiants assis dans la classe
* @param m Nombre d'etudiants qui suit ce que je dit dans la classe
*/
public JavadocDemo( int n, int m ) {
//...
}
/**
* Effectue le calcul de la suite de fibonnaci
*
* @param n Valeur a calculer
* @return L'evaluation de fib(n)
*/
public int fib( int n ) {
}
/**
* Le programme n'effectue absolument rien.
*/
public static void main( String args[] ) {
//...
}
}
/*
bor% javadoc JavadocDemo.java -d javadocDemo/
Loading source file JavadocDemo.java...
Constructing Javadoc information...
Standard Doclet version 1.4.2_04
Generating javadocDemo/constant-values.html...
Building tree for all the packages and classes...
Building index for all the packages and classes...
Generating javadocDemo/overview-tree.html...
Generating javadocDemo/index-all.html...
Generating javadocDemo/deprecated-list.html...
Building index for all classes...
Generating javadocDemo/allclasses-frame.html...
Generating javadocDemo/allclasses-noframe.html...
Generating javadocDemo/index.html...
Generating javadocDemo/packages.html...
Generating javadocDemo/JavadocDemo.html...
Generating javadocDemo/package-list...
Generating javadocDemo/help-doc.html...
Generating javadocDemo/stylesheet.css...
*/