Package org.apache.polaris.docs.generator

Class ReferenceConfigDocsGenerator

java.lang.Object

org.apache.polaris.docs.generator.ReferenceConfigDocsGenerator

All Implemented Interfaces:

Callable<Integer>

public class ReferenceConfigDocsGenerator
extends Object
implements Callable<Integer>

Tool to run DocGenDoclet, the markdown docs generation.

This is built as a separate tool, because running DocGenDoclet inside javadoc leads to wrong and incomplete results for smallrye-config documentation due to class loader isolation issues. javadoc uses a separate ClassLoader for the doclet, which breaks the proper inspection via smallrye-config's using ConfigMappingInterface: the default values are missing, properties from supertypes are missing and the property names are usually wrong.

This separate tool approach makes the integration into Gradle easier, too.

Constructor Summary

Constructors

Constructor	Description
ReferenceConfigDocsGenerator()
ReferenceConfigDocsGenerator(List<Path> sourcepath, List<Path> classpath, Path output, boolean verbose)

Method Summary

Modifier and Type	Method	Description
Integer	call()
static void	main(String[] args)

Methods inherited from class java.lang.Object

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

Constructor Details

ReferenceConfigDocsGenerator

public ReferenceConfigDocsGenerator()

ReferenceConfigDocsGenerator

public ReferenceConfigDocsGenerator(List<Path> sourcepath,
 List<Path> classpath,
 Path output,
 boolean verbose)

Method Details

call

public Integer call()
             throws Exception

Specified by:

call in interface Callable<Integer>

Throws:

Exception

main

public static void main(String[] args)