Class DocumentationExtractor
java.lang.Object
org.infinispan.protostream.annotations.impl.types.DocumentationExtractor
- Since:
- 3.0
- Author:
- [email protected]
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic String
getDocumentation
(Class<?> clazz, boolean fullyQualified) static String
getDocumentation
(Field f, boolean fullyQualified) static String
getDocumentation
(Method method, boolean fullyQualified) static String
getDocumentation
(Element element, boolean fullyQualified) Collect and concatenate the description text from an element (type, field, method).
-
Field Details
-
PROTOSTREAM_ANNOTATIONS_PREFIX
- See Also:
-
-
Constructor Details
-
DocumentationExtractor
public DocumentationExtractor()
-
-
Method Details
-
getDocumentation
Collect and concatenate the description text from an element (type, field, method). This unwraps@ProtoDoc.value
s 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 thennull
is returned. -
getDocumentation
-
getDocumentation
-
getDocumentation
-