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

weka.core.GlobalInfoJavadoc 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 .
 */

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

package weka.core;

import java.lang.reflect.Method;

/**
 * Generates Javadoc comments from the class's globalInfo method. Can 
 * automatically update the comments if they're surrounded by
 * the GLOBALINFO_STARTTAG and GLOBALINFO_ENDTAG (the indention is determined via
 * the GLOBALINFO_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.
* * * @author fracpete (fracpete at waikato dot ac dot nz) * @version $Revision: 8034 $ * @see #GLOBALINFO_METHOD * @see #GLOBALINFO_STARTTAG * @see #GLOBALINFO_ENDTAG */ public class GlobalInfoJavadoc extends Javadoc { /** the globalInfo method name */ public final static String GLOBALINFO_METHOD = "globalInfo"; /** the start comment tag for inserting the generated Javadoc */ public final static String GLOBALINFO_STARTTAG = ""; /** the end comment tag for inserting the generated Javadoc */ public final static String GLOBALINFO_ENDTAG = ""; /** * default constructor */ public GlobalInfoJavadoc() { super(); m_StartTag = new String[1]; m_EndTag = new String[1]; m_StartTag[0] = GLOBALINFO_STARTTAG; m_EndTag[0] = GLOBALINFO_ENDTAG; } /** * 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 */ protected String generateJavadoc(int index) throws Exception { String result; Method method; result = ""; if (index == 0) { if (!canInstantiateClass()) return result; try { method = getInstance().getClass().getMethod(GLOBALINFO_METHOD, (Class[]) null); } catch (Exception e) { // no method "globalInfo" return result; } // retrieve global info result = toHTML((String) method.invoke(getInstance(), (Object[]) null)); result = result.trim() + "\n

\n"; // stars? if (getUseStars()) result = indent(result, 1, "* "); } return result; } /** * Returns the revision string. * * @return the revision */ public String getRevision() { return RevisionUtils.extract("$Revision: 8034 $"); } /** * 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 GlobalInfoJavadoc(), args); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy