Package edu.uiuc.ncsa.qdl.statements
Interface Documentable
-
- All Superinterfaces:
Serializable
public interface Documentable extends Serializable
Created by Jeff Gaynor
on 5/27/20 at 9:47 AM
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<String>
getDocumentation(FKey key)
List<String>
getDocumentation(String fName, int argCount)
Get the complete documentation for a specific function.List<String>
listAllDocs()
Return the first lines of all the function documentation this module knows.List<String>
listAllDocs(String functionName)
Return the first line of all documentation for the given function name.TreeSet<String>
listFunctions(String regex)
List first lines of function documentation given a regular expression.
-
-
-
Method Detail
-
listFunctions
TreeSet<String> listFunctions(String regex)
List first lines of function documentation given a regular expression.- Parameters:
regex
-- Returns:
-
listAllDocs
List<String> listAllDocs()
Return the first lines of all the function documentation this module knows.- Returns:
-
listAllDocs
List<String> listAllDocs(String functionName)
Return the first line of all documentation for the given function name.- Parameters:
functionName
-- Returns:
-
getDocumentation
List<String> getDocumentation(String fName, int argCount)
Get the complete documentation for a specific function.- Parameters:
fName
-argCount
-- Returns:
-
-