operatordocgenerator.java

来自「著名的开源仿真软件yale」· Java 代码 · 共 49 行

/*
 *  YALE - Yet Another Learning Environment
 *  Copyright (C) 2002, 2003
 *      Simon Fischer, Ralf Klinkenberg, Ingo Mierswa, 
 *          Katharina Morik, Oliver Ritthoff
 *      Artificial Intelligence Unit
 *      Computer Science Department
 *      University of Dortmund
 *      44221 Dortmund,  Germany
 *  email: [e-mail]
 *  web:   http://yale.cs.uni-dortmund.de/
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License as 
 *  published by the Free Software Foundation; either version 2 of the
 *  License, or (at your option) any later version. 
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 *  USA.
 */
package edu.udo.cs.yale.doc;

import edu.udo.cs.yale.operator.Operator;

import com.sun.javadoc.RootDoc;
import java.io.PrintWriter;

/** Generates the documentation for operators.
 *
 *  @version $Id: OperatorDocGenerator.java,v 2.3 2003/05/06 20:02:10 fischer Exp $ */
public interface OperatorDocGenerator {
    
    /** Generates the documentation for this operator and writes it to the given writer. */
    public void generateDoc(Operator operator, RootDoc rootDoc, PrintWriter out);

    /** Generates the header for the group with the given name. */
    public void beginGroup(String groupName, PrintWriter out);

    /** Generates the footer for the group with the given name. */
    public void endGroup(String groupName, PrintWriter out);
}