Class DocumentationExtractor
- java.lang.Object
-
- org.infinispan.protostream.annotations.impl.types.DocumentationExtractor
-
public final class DocumentationExtractor extends Object
- Since:
- 3.0
- Author:
- anistor@redhat.com
-
-
Field Summary
Fields Modifier and Type Field Description static StringPROTOSTREAM_ANNOTATIONS_PREFIX
-
Constructor Summary
Constructors Constructor Description DocumentationExtractor()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static StringgetDocumentation(Class<?> clazz, boolean fullyQualified)static StringgetDocumentation(Field f, boolean fullyQualified)static StringgetDocumentation(Method method, boolean fullyQualified)static StringgetDocumentation(Element element, boolean fullyQualified)Collect and concatenate the description text from an element (type, field, method).
-
-
-
Field Detail
-
PROTOSTREAM_ANNOTATIONS_PREFIX
public static final String PROTOSTREAM_ANNOTATIONS_PREFIX
- See Also:
- Constant Field Values
-
-
Method Detail
-
getDocumentation
public static String getDocumentation(Element element, boolean fullyQualified)
Collect and concatenate the description text from an element (type, field, method). This unwraps@ProtoDoc.values and copies other annotations as-is. The beginning and trailing empty lines are trimmed off. If the resulting documentation text does not have any line thennullis returned.
-
-