edu.cmu.sphinx.tools.gui.util
Class JavadocExtractor

java.lang.Object
  extended by edu.cmu.sphinx.tools.gui.util.JavadocExtractor

public class JavadocExtractor
extends java.lang.Object

This is a helper class to retrieve the javadoc information of Sphinx classes

Author:
Ariani

Constructor Summary
JavadocExtractor()
           
 
Method Summary
static java.lang.String getJavadocComment(java.lang.String classname, java.lang.String class_path, java.lang.String source_path, java.lang.String prop_name)
          do string manipulation to get the property comment
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JavadocExtractor

public JavadocExtractor()
Method Detail

getJavadocComment

public static java.lang.String getJavadocComment(java.lang.String classname,
                                                 java.lang.String class_path,
                                                 java.lang.String source_path,
                                                 java.lang.String prop_name)
do string manipulation to get the property comment

Parameters:
classname - Fully qualified class name that holds the property
class_path - Absolute path to the root of .class files; must end in '\' or '/'
source_path - Absolute path to the source code root directory; must end in '\' or '/'
prop_name - Name of property to be searched
Returns:
Javadoc comment for the property that belongs to classname