de.kosi.doc
Class LatexDoclet

java.lang.Object
  |
  +--com.sun.javadoc.Doclet
        |
        +--de.kosi.doc.LatexDoclet

public class LatexDoclet

extends com.sun.javadoc.Doclet

This class is a doclet, that generates a embeddable latex file from the javadoc documentation.

ChangeLog:

 
 $Log: LatexDoclet.java,v $
 Revision 1.2  2001/06/04 14:21:10  jiriki
 Made source more comliant to coding guidelines.

 Revision 1.1.1.1  2001/04/29 18:05:16  jiriki
 Imported sources from zola.

 Revision 1.2  2001/02/19 15:51:47  wombat
 - Latex Task geschrieben
 - Entwurfsdokumente in Webseite eingebunden
 - Game Entwurfsdokument und Source aktualisiert.

 Revision 1.1  2001/02/11 23:38:01  wombat
 - Started implementation of Game/GameListener
 - Started implementation of Latex Doclet
 - Documentation for Game

 

Version:

$Revision: 1.2 $ ($Date: 2001/06/04 14:21:10 $)

Author:

Jan-Ole Janssen, Niklas Mehner, Time Sticher

Field Summary

static java.lang.String	OUTFILE File the documentation is written to.
static java.lang.String[]	SECTION_NAMES Hierarchy of latex sections.

Method Summary

static boolean

start(com.sun.javadoc.RootDoc root) This method is called by javadoc.

Methods inherited from class com.sun.javadoc.Doclet

optionLength, validOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OUTFILE

public static final java.lang.String OUTFILE

File the documentation is written to.

SECTION_NAMES

public static final java.lang.String[] SECTION_NAMES

Hierarchy of latex sections.

Method Detail

start

public static boolean start(com.sun.javadoc.RootDoc root)

This method is called by javadoc.

Parameters:

root - Information about the classes to be documented.

Returns:

true if the documentation has successfully been created.