Class DocumentationExtractor


  • public final class DocumentationExtractor
    extends Object
    Since:
    3.0
    Author:
    anistor@redhat.com
    • Constructor Detail

      • DocumentationExtractor

        public DocumentationExtractor()
    • 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 then null is returned.
      • getDocumentation

        public static String getDocumentation​(Field f,
                                              boolean fullyQualified)
      • getDocumentation

        public static String getDocumentation​(Class<?> clazz,
                                              boolean fullyQualified)
      • getDocumentation

        public static String getDocumentation​(Method method,
                                              boolean fullyQualified)