public class DocumentationUtils extends Object
| Constructor and Description |
|---|
DocumentationUtils() |
| Modifier and Type | Method and Description |
|---|---|
static SetJIPipeDocumentation |
createDocumentation(String name,
String description) |
static SetJIPipeDocumentation |
createDocumentation(String name,
String descriptionResourceURL,
Class<?> descriptionResourceClass) |
static String |
getDocumentationDescription(AddJIPipeDocumentationDescription documentation)
Returns the documentation description string if available.
|
static String |
getDocumentationDescription(Class<?> klass)
Returns the documentation description string if available.
|
static String |
getDocumentationDescription(SetJIPipeDocumentation documentation)
Returns the documentation description string if available.
|
static String |
getDocumentationDescription(SetJIPipeDocumentation documentation,
Class<?> klass)
Returns the documentation description string if available.
|
public static SetJIPipeDocumentation createDocumentation(String name, String description)
public static SetJIPipeDocumentation createDocumentation(String name, String descriptionResourceURL, Class<?> descriptionResourceClass)
public static String getDocumentationDescription(SetJIPipeDocumentation documentation)
documentation - the documentation annotationpublic static String getDocumentationDescription(AddJIPipeDocumentationDescription documentation)
documentation - the documentation annotationpublic static String getDocumentationDescription(SetJIPipeDocumentation documentation, Class<?> klass)
documentation - the first documentationklass - the class the contains SetJIPipeDocumentation and AddJIPipeDocumentationDescription itemspublic static String getDocumentationDescription(Class<?> klass)
klass - the class the contains SetJIPipeDocumentation and AddJIPipeDocumentationDescription itemsCopyright © 2020–2025 Leibniz Institute for Natural Product Research and Infection Biology - Hans Knöll Institute (HKI). All rights reserved.