com.github.jlangch.venice.impl.docgen

Class DocItem

java.lang.Object

com.github.jlangch.venice.impl.docgen.DocItem

public class DocItem
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DocItem(java.lang.String name, java.util.List<java.lang.String> signatures, java.lang.String description, java.util.List<Output> examples, java.lang.String id)
DocItem(java.lang.String name, java.lang.String id)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDescription()
java.lang.String	getExamples()
java.lang.String	getId()
java.lang.String	getName()
java.util.List<java.lang.String>	getSignatures()
int	hashCode()
java.lang.String	renderExamples()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocItem

public DocItem(java.lang.String name,
               java.util.List<java.lang.String> signatures,
               java.lang.String description,
               java.util.List<Output> examples,
               java.lang.String id)

DocItem

public DocItem(java.lang.String name,
               java.lang.String id)

Method Detail

getName

public java.lang.String getName()

getId

public java.lang.String getId()

getSignatures

public java.util.List<java.lang.String> getSignatures()

getDescription

public java.lang.String getDescription()

getExamples

public java.lang.String getExamples()

renderExamples

public java.lang.String renderExamples()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object