Package com.hubspot.jinjava.doc

Class JinjavaDocItem

java.lang.Object

com.hubspot.jinjava.doc.JinjavaDocItem

Direct Known Subclasses:

JinjavaDocExpTest, JinjavaDocFilter, JinjavaDocFunction, JinjavaDocTag

public abstract class JinjavaDocItem
extends Object

Constructor Summary

Constructors

Constructor	Description
JinjavaDocItem(String name, String desc, String aliasOf, boolean deprecated, JinjavaDocParam[] inputs, JinjavaDocParam[] params, JinjavaDocSnippet[] snippets, Map<String,String> meta)

Method Summary

Modifier and Type	Method	Description
String	getAliasOf()
String	getDesc()
JinjavaDocParam[]	getInputs()
Map<String,String>	getMeta()
String	getName()
JinjavaDocParam[]	getParams()
JinjavaDocSnippet[]	getSnippets()
boolean	isDeprecated()

Methods inherited from class java.lang.Object

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

Constructor Detail

JinjavaDocItem

public JinjavaDocItem(String name,
                      String desc,
                      String aliasOf,
                      boolean deprecated,
                      JinjavaDocParam[] inputs,
                      JinjavaDocParam[] params,
                      JinjavaDocSnippet[] snippets,
                      Map<String,String> meta)

Method Detail

getName

public String getName()

getDesc

public String getDesc()

getAliasOf

public String getAliasOf()

isDeprecated

public boolean isDeprecated()

getInputs

public JinjavaDocParam[] getInputs()

getParams

public JinjavaDocParam[] getParams()

getSnippets

public JinjavaDocSnippet[] getSnippets()

getMeta

public Map<String,String> getMeta()