DocumentationExtractor (ProtoStream - core 4.3.0.Alpha9 API)

java.lang.Object
- org.infinispan.protostream.annotations.impl.types.DocumentationExtractor

public final class DocumentationExtractor
extends Object

Since:: 3.0
Author:: [email protected]

Constructor Summary

Constructors
Constructor Description

DocumentationExtractor()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static String`	`getDocumentation(ProtoDoc[] annotations)`	Collect and concatenate the description text from the `@ProtoDoc.value` of the given ProtoDoc annotations (that were previously obtained either from an AnnotatedElement or an AnnotatedConstruct).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DocumentationExtractor
```
public DocumentationExtractor()
```
- Method Detail
  - getDocumentation
```
public static String getDocumentation(ProtoDoc[] annotations)
```
    Collect and concatenate the description text from the @ProtoDoc.value of the given ProtoDoc annotations (that were previously obtained either from an AnnotatedElement or an AnnotatedConstruct). Each annotation value is put on a separate line. The beginning and trailing empty lines are trimmed off. If the resulting documentation text does not have any line then null is returned.