com.github.therapi.runtimejavadoc.internal.parser

Class JavadocParser

java.lang.Object

com.github.therapi.runtimejavadoc.internal.parser.JavadocParser

public class JavadocParser
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
JavadocParser()

Method Summary

Modifier and Type	Method and Description
static ClassJavadoc	parseClassJavadoc(java.lang.String className, java.lang.String javadoc, java.util.List<FieldJavadoc> fields, java.util.List<FieldJavadoc> enumConstants, java.util.List<MethodJavadoc> methods, java.util.List<MethodJavadoc> constructors)
static FieldJavadoc	parseFieldJavadoc(java.lang.String owningClass, java.lang.String fieldName, java.lang.String javadoc)
static MethodJavadoc	parseMethodJavadoc(java.lang.String owningClass, java.lang.String methodName, java.util.List<java.lang.String> paramTypes, java.lang.String javadoc)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavadocParser

public JavadocParser()

Method Detail

parseClassJavadoc

public static ClassJavadoc parseClassJavadoc(java.lang.String className,
                                             java.lang.String javadoc,
                                             java.util.List<FieldJavadoc> fields,
                                             java.util.List<FieldJavadoc> enumConstants,
                                             java.util.List<MethodJavadoc> methods,
                                             java.util.List<MethodJavadoc> constructors)

parseFieldJavadoc

public static FieldJavadoc parseFieldJavadoc(java.lang.String owningClass,
                                             java.lang.String fieldName,
                                             java.lang.String javadoc)

parseMethodJavadoc

public static MethodJavadoc parseMethodJavadoc(java.lang.String owningClass,
                                               java.lang.String methodName,
                                               java.util.List<java.lang.String> paramTypes,
                                               java.lang.String javadoc)