All Downloads are FREE. Search and download functionalities are using the official Maven repository.

weka.core.OptionHandlerJavadoc Maven / Gradle / Ivy

Go to download

The Waikato Environment for Knowledge Analysis (WEKA), a machine learning workbench. This is the stable version. Apart from bugfixes, this version does not receive any other updates.

There is a newer version: 3.8.6
Show newest version
/*
 *   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 3 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, see .
 */

/*
 * OptionHandlerJavadoc.java
 * Copyright (C) 2006-2012,2015 University of Waikato, Hamilton, New Zealand
 */

package weka.core;

import java.util.Collections;
import java.util.Enumeration;
import java.util.Vector;

/**
 * Generates Javadoc comments from the OptionHandler's options. Can
 * automatically update the option comments if they're surrounded by the
 * OPTIONS_STARTTAG and OPTIONS_ENDTAG (the indention is determined via the
 * OPTIONS_STARTTAG).
 * 

* * Valid options are: *

* *

 * -W <classname>
 *  The class to load.
 * 
* *
 * -nostars
 *  Suppresses the '*' in the Javadoc.
 * 
* *
 * -dir <dir>
 *  The directory above the package hierarchy of the class.
 * 
* *
 * -silent
 *  Suppresses printing in the console.
 * 
* *
 * -noprolog
 *  Suppresses the 'Valid options are...' prolog in the Javadoc.
 * 
* * * * @author fracpete (fracpete at waikato dot ac dot nz) * @version $Revision: 11734 $ * @see #OPTIONS_STARTTAG * @see #OPTIONS_ENDTAG */ public class OptionHandlerJavadoc extends Javadoc { /** the start comment tag for inserting the generated Javadoc */ public final static String OPTIONS_STARTTAG = ""; /** the end comment tag for inserting the generated Javadoc */ public final static String OPTIONS_ENDTAG = ""; /** whether to include the "Valid options..." prolog in the Javadoc */ protected boolean m_Prolog = true; /** * default constructor */ public OptionHandlerJavadoc() { super(); m_StartTag = new String[1]; m_EndTag = new String[1]; m_StartTag[0] = OPTIONS_STARTTAG; m_EndTag[0] = OPTIONS_ENDTAG; } /** * Returns an enumeration describing the available options. * * @return an enumeration of all the available options. */ @Override public Enumeration




© 2015 - 2024 Weber Informatics LLC | Privacy Policy