de.ohmesoftware.javadoctoopenapischema

Class Enricher

java.lang.Object

de.ohmesoftware.javadoctoopenapischema.Enricher

public class Enricher
extends Object

Enriches the passed source path and sub directories and adds or sets the "description" property of the @Schema annotation from the Javadoc.

Author:

Karsten Ohme (k_o_@users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
Enricher(String sourcePath, Set<String> includes, Set<String> excludes, boolean hateaos) Constructor.

Method Summary

Modifier and Type	Method and Description
void	enrich()
protected String	escapeString(String string)
static void	main(String[] args)
protected com.github.javaparser.ast.body.TypeDeclaration	parseClassOrInterfaceType(String basePath, com.github.javaparser.ast.CompilationUnit compilationUnit, com.github.javaparser.ast.type.ClassOrInterfaceType classOrInterfaceType)
protected String	quoteString(String string)

Methods inherited from class java.lang.Object

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

Constructor Detail

Enricher

public Enricher(String sourcePath,
                Set<String> includes,
                Set<String> excludes,
                boolean hateaos)

Constructor.

Parameters:

sourcePath - The source path to enrich.

includes - The includes.

excludes - The excludes.

hateaos - true if HATEAOS is used. In this case associations are rendered as links.

Method Detail

main

public static void main(String[] args)

enrich

public void enrich()

parseClassOrInterfaceType

protected com.github.javaparser.ast.body.TypeDeclaration parseClassOrInterfaceType(String basePath,
                                                                                   com.github.javaparser.ast.CompilationUnit compilationUnit,
                                                                                   com.github.javaparser.ast.type.ClassOrInterfaceType classOrInterfaceType)

quoteString

protected String quoteString(String string)

escapeString

protected String escapeString(String string)