com.atlassian.jira.soy

Class HelpDescriptionFunction

java.lang.Object

com.atlassian.jira.soy.AbstractHelpFunction

com.atlassian.jira.soy.HelpDescriptionFunction

All Implemented Interfaces:

com.atlassian.soy.renderer.SoyClientFunction, com.atlassian.soy.renderer.SoyFunction, com.atlassian.soy.renderer.SoyServerFunction<String>

public class HelpDescriptionFunction
extends AbstractHelpFunction

getJiraHelpDesc('help_url_key_here') soy function.

Soy function that returns the description for a help URL specified by the provided help key.

Since:

v7.0

Constructor Summary

Constructors

Constructor and Description
HelpDescriptionFunction(HelpUrls helpUrls)

Method Summary

Modifier and Type	Method and Description
String	getName()

Methods inherited from class com.atlassian.jira.soy.AbstractHelpFunction

apply, generate, validArgSizes

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpDescriptionFunction

public HelpDescriptionFunction(HelpUrls helpUrls)

Method Detail

getName

public String getName()