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

weka.core.AllJavadoc Maven / Gradle / Ivy

Go to download

The Waikato Environment for Knowledge Analysis (WEKA), a machine learning workbench. This version represents the developer version, the "bleeding edge" of development, you could say. New functionality gets added to this version.

There is a newer version: 3.9.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 .
 */

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

package weka.core;

import java.util.HashSet;
import java.util.Vector;

/**
 * Applies all known Javadoc-derived classes to a source file.
 * 
 *  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.
 * 
* * * * @author fracpete (fracpete at waikato dot ac dot nz) * @version $Revision: 11736 $ */ public class AllJavadoc extends Javadoc { /** contains all the */ protected static Vector m_Javadocs; /** determine all classes derived from Javadoc and instantiate them */ static { // get all classnames, besides this one HashSet set = new HashSet(ClassDiscovery.find( Javadoc.class, Javadoc.class.getPackage().getName())); if (set.contains(AllJavadoc.class.getName())) { set.remove(AllJavadoc.class.getName()); } // instantiate them m_Javadocs = new Vector(); for (String classname : set) { try { Class cls = Class.forName(classname); m_Javadocs.add((Javadoc) cls.newInstance()); } catch (Exception e) { e.printStackTrace(); } } } /** * sets the classname of the class to generate the Javadoc for * * @param value the new classname */ @Override public void setClassname(String value) { super.setClassname(value); for (int i = 0; i < m_Javadocs.size(); i++) { m_Javadocs.get(i).setClassname(value); } } /** * sets whether to prefix the Javadoc with "*" * * @param value true if stars are to be used */ @Override public void setUseStars(boolean value) { super.setUseStars(value); for (int i = 0; i < m_Javadocs.size(); i++) { m_Javadocs.get(i).setUseStars(value); } } /** * sets whether to suppress output in the console * * @param value true if output is to be suppressed */ @Override public void setSilent(boolean value) { super.setSilent(value); for (int i = 0; i < m_Javadocs.size(); i++) { m_Javadocs.get(i).setSilent(value); } } /** * generates and returns the Javadoc for the specified start/end tag pair. * * @param index the index in the start/end tag array * @return the generated Javadoc * @throws Exception in case the generation fails */ @Override protected String generateJavadoc(int index) throws Exception { throw new Exception("Not used!"); } /** * updates the Javadoc in the given source code, using all the found Javadoc * updaters. * * @param content the source code * @return the updated source code * @throws Exception in case the generation fails */ @Override protected String updateJavadoc(String content) throws Exception { String result; int i; result = content; for (i = 0; i < m_Javadocs.size(); i++) { result = m_Javadocs.get(i).updateJavadoc(result); } return result; } /** * Returns the revision string. * * @return the revision */ @Override public String getRevision() { return RevisionUtils.extract("$Revision: 11736 $"); } /** * Parses the given commandline parameters and generates the Javadoc. * * @param args the commandline parameters for the object */ public static void main(String[] args) { runJavadoc(new AllJavadoc(), args); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy