\documentclass[11pt]{report} \def\blankline{\hbox{}\newline\phantom{o}\phantom{o}\newline} \newcommand{\hide}[2]{ } \newcommand{\membername}[1]{{\it #1}\linebreak} \newcommand{\divideents}[1]{\vskip -1em\indent\hbox to 2in{\hrulefill}} \newcommand{\refdefined}[1]{ \expandafter\ifx\csname r@#1\endcsname\relax \relax\else {$($ in \ref{#1}, page \pageref{#1}$)$} \fi} \usepackage{color} \date{\today} \pagestyle{myheadings} \addtocontents{toc}{\protect\def\protect\packagename{}} \addtocontents{toc}{\protect\def\protect\classname{}} \markboth{\protect\packagename -- \protect\classname}{\protect\packagename -- \protect\classname} \oddsidemargin 0in \evensidemargin 0in \topmargin -.8in \chardef\bslash=`\\ \textheight 9.4in \textwidth 6.5in \title{Example Documentation Generated by the \LaTeX\ Java 2 doclet} \author{C2 Technologies Inc.} \begin{document} \maketitle \sloppy \raggedright \tableofcontents \newpage \def\packagename{com.c2\_tech.doclets} \chapter{\bf Package com.c2\_tech.doclets}{ \vskip -.25in \hbox to \hsize{\it Package Contents\hfil Page} \hrule \vskip .13in \hbox{\bf Classes} \hbox to \hsize{\vbox{\hbox to .2in{}}{\bf Package}\dotfill \pageref{com.c2_tech.doclets.Package} } \hbox to \hsize{\vbox{\hbox to .2in{}}{\bf TableInfo}\dotfill \pageref{com.c2_tech.doclets.TableInfo} } \hbox to \hsize{\vbox{\hbox to .2in{}}{\bf TexDoclet}\dotfill \pageref{com.c2_tech.doclets.TexDoclet} } \vskip .1in \hrule \vskip .1in \newpage \section{Classes}{ \gdef\classname{Package} \subsection{\label{com.c2_tech.doclets.Package}{\bf {\it Class} Package}}{ \rule[1em]{\hsize}{4pt}\vskip -1em \vskip .1in {\small This class is used to manage the contents of a Java package. It accepts ClassDoc objects and examines them and groups them according to whether they are classes, interfaces, exceptions or errors. The accumulated Vectors can then be processed to get to all of the elements of the package that fall into each catagory.} \vskip .1in \subsubsection{Declaration}{ \fbox{\vbox{ \hbox{\vbox{\small public class Package}} \noindent\hbox{\vbox{{\bf extends} java.lang.Object}} }}} \subsubsection{Constructors}{ \rule[1em]{\hsize}{2pt}\vskip -2em \begin{itemize} \item{\vskip -1.9ex \membername{Package} {\tt public {\bf Package}( {\tt java.lang.String } {\bf pkg} ) \label{com.c2_tech.doclets.Package/Package} }%end signature \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Usage} \begin{itemize} \item{ Construct a new object corresponding to the passed package name. }%end item \end{itemize} } \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Parameters} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt pkg} - the package name to use} \end{itemize} }%end item \end{itemize} }%end item \end{itemize} } \subsubsection{Methods}{ \rule[1em]{\hsize}{2pt}\vskip -2em \begin{itemize} \item{\vskip -1.9ex \membername{addElement} {\tt public void {\bf addElement}( {\tt com.sun.javadoc.ClassDoc } {\bf cd} ) \label{com.c2_tech.doclets.Package/addElement} }%end signature \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Usage} \begin{itemize} \item{ Adds a ClassDoc element to this package. }%end item \end{itemize} } \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Parameters} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt cd} - the object to add to this package} \end{itemize} }%end item \end{itemize} }%end item \end{itemize} } } \gdef\classname{TableInfo} \subsection{\label{com.c2_tech.doclets.TableInfo}{\bf {\it Class} TableInfo}}{ \rule[1em]{\hsize}{4pt}\vskip -1em \vskip .1in {\small This class provides support for converting HTML tables into LaTeX tables. Some of the things {\bf NOT} implemented include the following: \begin{itemize} \item{\vskip -.8ex valign attributes are not procesed, but align= is. } \item{\vskip -.8ex rowspan attributes are not processed, but colspan= is. } \item{\vskip -.8ex the argument to border= in the table tag is not used to control line size } \end{itemize} \mbox{}\newline Here is an example table. \blankline \begin{tabular}{|c|c|c|} \hline {\bf Column 1 Heading} & {\bf Column two heading} & {\bf Column three heading } \\ \hline {data} & \multicolumn{2}{c|}{Span two columns } \\ \hline {{\it more data}} & \multicolumn{1}{r|}{right} & \multicolumn{1}{l|}{left } \\ \hline \multicolumn{3}{|c|}{\begin{tabular}{|c|c|c|} \hline \multicolumn{3}{|c|}{\bf A nested table example } \\ \hline {\bf Column 1 Heading} & {\bf Column two heading} & {\bf Column three heading } \\ \hline {data} & \multicolumn{2}{c|}{Span two columns } \\ \hline {{\it more data}} & \multicolumn{1}{r|}{right} & \multicolumn{1}{l|}{left } \\ \hline \end{tabular} } \\ \hline \end{tabular} } \vskip .1in \subsubsection{Declaration}{ \fbox{\vbox{ \hbox{\vbox{\small public class TableInfo}} \noindent\hbox{\vbox{{\bf extends} java.lang.Object}} }}} \subsubsection{Constructors}{ \rule[1em]{\hsize}{2pt}\vskip -2em \begin{itemize} \item{\vskip -1.9ex \membername{TableInfo} {\tt public {\bf TableInfo}( {\tt java.util.Properties } {\bf p}, {\tt java.lang.StringBuffer } {\bf ret}, {\tt java.lang.String } {\bf table}, {\tt int } {\bf off} ) \label{com.c2_tech.doclets.TableInfo/TableInfo} }%end signature \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Usage} \begin{itemize} \item{ Constructs a new table object and starts processing of the table by scanning the {\tt \textless table\textgreater } passed to count columns. }%end item \end{itemize} } \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Parameters} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt p} - properties found on the {\tt \textless table\textgreater } tag} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt ret} - the result buffer that will contain the output} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt table} - the input string that has the entire table definition in it.} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt off} - the offset into {\tt \textless table\textgreater } where scanning should start} \end{itemize} }%end item \end{itemize} }%end item \end{itemize} } \subsubsection{Methods}{ \rule[1em]{\hsize}{2pt}\vskip -2em \begin{itemize} \item{\vskip -1.9ex \membername{endCol} {\tt public void {\bf endCol}( {\tt java.lang.StringBuffer } {\bf ret} ) \label{com.c2_tech.doclets.TableInfo/endCol} }%end signature \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Usage} \begin{itemize} \item{ Ends the current column. }%end item \end{itemize} } \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Parameters} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt ret} - the output buffer to put LaTeX into} \end{itemize} }%end item \end{itemize} }%end item \divideents{endRow} \item{\vskip -1.9ex \membername{endRow} {\tt public void {\bf endRow}( {\tt java.lang.StringBuffer } {\bf ret} ) \label{com.c2_tech.doclets.TableInfo/endRow} }%end signature \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Usage} \begin{itemize} \item{ Ends the current row. }%end item \end{itemize} } \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Parameters} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt ret} - the output buffer to put LaTeX into} \end{itemize} }%end item \end{itemize} }%end item \divideents{endTable} \item{\vskip -1.9ex \membername{endTable} {\tt public void {\bf endTable}( {\tt java.lang.StringBuffer } {\bf ret} ) \label{com.c2_tech.doclets.TableInfo/endTable} }%end signature \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Usage} \begin{itemize} \item{ Ends the table, closing the last row as needed }%end item \end{itemize} } \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Parameters} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt ret} - the output buffer to put LaTeX into} \end{itemize} }%end item \end{itemize} }%end item \divideents{startCol} \item{\vskip -1.9ex \membername{startCol} {\tt public void {\bf startCol}( {\tt java.lang.StringBuffer } {\bf ret}, {\tt java.util.Properties } {\bf p} ) \label{com.c2_tech.doclets.TableInfo/startCol} }%end signature \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Usage} \begin{itemize} \item{ Starts a new column, possibly closing the current column if needed }%end item \end{itemize} } \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Parameters} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt ret} - the output buffer to put LaTeX into} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt p} - the properties from the {\tt \textless td\textgreater } tag} \end{itemize} }%end item \end{itemize} }%end item \divideents{startHeadCol} \item{\vskip -1.9ex \membername{startHeadCol} {\tt public void {\bf startHeadCol}( {\tt java.lang.StringBuffer } {\bf ret}, {\tt java.util.Properties } {\bf p} ) \label{com.c2_tech.doclets.TableInfo/startHeadCol} }%end signature \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Usage} \begin{itemize} \item{ Starts a new Heading column, possibly closing the current column if needed. A Heading column has a Bold Face font directive around it. }%end item \end{itemize} } \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Parameters} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt ret} - the output buffer to put LaTeX into} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt p} - the properties from the {\tt \textless th\textgreater } tag} \end{itemize} }%end item \end{itemize} }%end item \divideents{startRow} \item{\vskip -1.9ex \membername{startRow} {\tt public void {\bf startRow}( {\tt java.lang.StringBuffer } {\bf ret}, {\tt java.util.Properties } {\bf p} ) \label{com.c2_tech.doclets.TableInfo/startRow} }%end signature \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Usage} \begin{itemize} \item{ Starts a new row, possibly closing the current row if needed }%end item \end{itemize} } \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Parameters} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt ret} - the output buffer to put LaTeX into} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt p} - the properties from the {\tt \textless tr\textgreater } tag} \end{itemize} }%end item \end{itemize} }%end item \end{itemize} } } \gdef\classname{TexDoclet} \subsection{\label{com.c2_tech.doclets.TexDoclet}{\bf {\it Class} TexDoclet}}{ \rule[1em]{\hsize}{4pt}\vskip -1em \vskip .1in {\small This class provides a Java 2, {\tt javadoc} Doclet which generates a LaTeX2e document out of the java classes that it is used on. This is convienent for creating printable documentation complete with cross reference information. \blankline Supported HTML tags within comments incude the following \begin{itemize} \item[\textless dl\textgreater ]{with the associated \textless dt\textgreater \textless dd\textgreater \textless $/$dl\textgreater tags } \item[\textless p\textgreater ]{but not align=center...yet } \item[\textless br\textgreater ]{but not clear=xxx } \item[\textless table\textgreater ]{including all the associcated \textless td\textgreater \textless th\textgreater \textless tr\textgreater \textless $/$td\textgreater \textless $/$th\textgreater \textless $/$tr\textgreater } \item[\textless ol\textgreater ]{ordered lists } \item[\textless ul\textgreater ]{unordered lists } \item[\textless font\textgreater ]{font coloring } \item[\textless pre\textgreater ]{preformatted text } \item[\textless code\textgreater ]{fixed point fonts } \item[\textless i\textgreater ]{italized fonts } \item[\textless b\textgreater ]{bold fonts } \end{itemize}} \vskip .1in \subsubsection{Declaration}{ \fbox{\vbox{ \hbox{\vbox{\small public class TexDoclet}} \noindent\hbox{\vbox{{\bf extends} com.sun.javadoc.Doclet}} }}} \subsubsection{Fields}{ \rule[1em]{\hsize}{2pt} \begin{itemize} \item{ public static PrintWriter os\begin{itemize}\item{\vskip -.9ex Writer for writing to output file}\end{itemize} } \end{itemize} } \subsubsection{Constructors}{ \rule[1em]{\hsize}{2pt}\vskip -2em \begin{itemize} \item{\vskip -1.9ex \membername{TexDoclet} {\tt public {\bf TexDoclet}( ) \label{com.c2_tech.doclets.TexDoclet/TexDoclet} }%end signature }%end item \end{itemize} } \subsubsection{Methods}{ \rule[1em]{\hsize}{2pt}\vskip -2em \begin{itemize} \item{\vskip -1.9ex \membername{optionLength} {\tt public static int {\bf optionLength}( {\tt java.lang.String } {\bf option} ) \label{com.c2_tech.doclets.TexDoclet/optionLength} }%end signature \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Usage} \begin{itemize} \item{ Returns how many arguments would be consumed if {\tt option} is a recognized option. }%end item \end{itemize} } \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Parameters} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt option} - the option to check} \end{itemize} }%end item \end{itemize} }%end item \divideents{start} \item{\vskip -1.9ex \membername{start} {\tt public static boolean {\bf start}( {\tt com.sun.javadoc.RootDoc } {\bf root} ) \label{com.c2_tech.doclets.TexDoclet/start} }%end signature \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Usage} \begin{itemize} \item{ Called by the framework to format the entire document }%end item \end{itemize} } \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Parameters} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt root} - the root of the starting document} \end{itemize} }%end item \end{itemize} }%end item \divideents{validOptions} \item{\vskip -1.9ex \membername{validOptions} {\tt public static boolean {\bf validOptions}( {\tt java.lang.String [][]} {\bf args}, {\tt com.sun.javadoc.DocErrorReporter } {\bf err} ) \label{com.c2_tech.doclets.TexDoclet/validOptions} }%end signature \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Usage} \begin{itemize} \item{ Checks the passed options and their arguments for validity. }%end item \end{itemize} } \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\bf Parameters} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \begin{itemize} \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} \setlength{\itemsep}{-.4ex} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt args} - the arguments to check} \item{ \setlength{\topsep}{0em} \setlength{\partopsep}{0em} \setlength{\parskip}{0em} \setlength{\parsep}{-1em} {\tt err} - the interface to use for reporting errors} \end{itemize} }%end item \end{itemize} }%end item \end{itemize} } \subsubsection{Methods inherited from class {\tt com.sun.javadoc.Doclet}}{ \par{\small \refdefined{com.sun.javadoc.Doclet}\rule[1em]{\hsize}{2pt}\vskip -2em \begin{itemize} \item{\vskip -1.9ex \membername{optionLength} {\tt public static int {\bf optionLength}( {\tt java.lang.String } {\bf } ) }%end signature }%end item \divideents{start} \item{\vskip -1.9ex \membername{start} {\tt public static boolean {\bf start}( {\tt com.sun.javadoc.RootDoc } {\bf } ) }%end signature }%end item \divideents{validOptions} \item{\vskip -1.9ex \membername{validOptions} {\tt public static boolean {\bf validOptions}( {\tt java.lang.String [][]} {\bf }, {\tt com.sun.javadoc.DocErrorReporter } {\bf } ) }%end signature }%end item \end{itemize} }} } } } \end{document}