Class FDocFuncs

java.lang.Object

io.nosqlbench.virtdata.userlibs.apps.docsapp.fdocs.FDocFuncs

All Implemented Interfaces:

Iterable<FDocFunc>

public class FDocFuncs
extends Object
implements Iterable<FDocFunc>

holds all FunctionDoc instances for the same basic function name

Constructor Summary

Constructors

Constructor	Description
FDocFuncs(String functionName)

Method Summary

Modifier and Type	Method	Description
void	addFunctionDoc(FDocFunc FDocFunc)
String	asMarkdown()
String	getCombinedClassDocs()
String	getFunctionName()
Iterator<FDocFunc>	iterator()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

FDocFuncs

public FDocFuncs(String functionName)

Method Details

getFunctionName

public String getFunctionName()

addFunctionDoc

public void addFunctionDoc(FDocFunc FDocFunc)

iterator

public Iterator<FDocFunc> iterator()

Specified by:

iterator in interface Iterable<FDocFunc>

getCombinedClassDocs

public String getCombinedClassDocs()

asMarkdown

public String asMarkdown()

toString

public String toString()

Overrides:

toString in class Object