Documentable (QDL root module 1.6.2.3 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

FStack, FTable, MITable
```
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(String fName, int argCount)`	Get the complete documentation for a specific function.
`List<String>`	`getDocumentation(FKey key)`
`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. If the regular expression is null, then no filtering is done.
    
    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:
  - getDocumentation
```
List<String> getDocumentation(FKey key)
```