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