org.ballerinalang.docgen.docs

Class BallerinaDocGenerator

java.lang.Object

org.ballerinalang.docgen.docs.BallerinaDocGenerator

public class BallerinaDocGenerator
extends Object

Main class to generate a ballerina documentation.

Constructor Summary

Constructors

Constructor and Description
BallerinaDocGenerator()

Method Summary

Modifier and Type	Method and Description
static void	generateApiDocs(String output, String packageFilter, boolean isNative, String... sources) API to generate Ballerina API documentation.
protected static Map<String,BLangPackage>	generatePackageDocsFromBallerina(String sourceRoot, Path packagePath, String packageFilter, boolean isNative) Generates BLangPackage objects for each Ballerina package from the given ballerina files.
protected static Map<String,BLangPackage>	generatePackageDocsFromBallerina(String sourceRoot, String packagePath) Generates BLangPackage objects for each Ballerina package from the given ballerina files.
protected static Map<String,BLangPackage>	generatePackageDocsFromBallerina(String sourceRoot, String packagePath, String packageFilter) Generates BLangPackage objects for each Ballerina package from the given ballerina files.
protected static Map<String,BLangPackage>	generatePackageDocsFromBallerina(String sourceRoot, String packagePath, String packageFilter, boolean isNative) Generates BLangPackage objects for each Ballerina package from the given ballerina files.

Methods inherited from class java.lang.Object

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

Constructor Detail

BallerinaDocGenerator

public BallerinaDocGenerator()

Method Detail

generateApiDocs

public static void generateApiDocs(String output,
                                   String packageFilter,
                                   boolean isNative,
                                   String... sources)

API to generate Ballerina API documentation.

Parameters:

output - path to the output directory where the API documentation will be written to.

packageFilter - comma separated list of package names to be filtered from the documentation.

isNative - whether the given packages are native or not.

sources - either the path to the directories where Ballerina source files reside or a path to a Ballerina file which does not belong to a package.

generatePackageDocsFromBallerina

protected static Map<String,BLangPackage> generatePackageDocsFromBallerina(String sourceRoot,
                                                                           String packagePath)
                                                                    throws IOException

Generates BLangPackage objects for each Ballerina package from the given ballerina files.

Parameters:

sourceRoot - points to the folder relative to which package path is given

packagePath - should point either to a ballerina file or a folder with ballerina files.

Returns:

a map of BLangPackage objects. Key - Ballerina package name Value - BLangPackage

Throws:

IOException

generatePackageDocsFromBallerina

protected static Map<String,BLangPackage> generatePackageDocsFromBallerina(String sourceRoot,
                                                                           String packagePath,
                                                                           String packageFilter)
                                                                    throws IOException

Generates BLangPackage objects for each Ballerina package from the given ballerina files.

Parameters:

sourceRoot - points to the folder relative to which package path is given

packagePath - should point either to a ballerina file or a folder with ballerina files.

packageFilter - comma separated list of package names/patterns to be filtered from the documentation.

Returns:

a map of BLangPackage objects. Key - Ballerina package name Value - BLangPackage

Throws:

IOException

generatePackageDocsFromBallerina

protected static Map<String,BLangPackage> generatePackageDocsFromBallerina(String sourceRoot,
                                                                           String packagePath,
                                                                           String packageFilter,
                                                                           boolean isNative)
                                                                    throws IOException

Generates BLangPackage objects for each Ballerina package from the given ballerina files.

Parameters:

sourceRoot - points to the folder relative to which package path is given

packagePath - should point either to a ballerina file or a folder with ballerina files.

packageFilter - comma separated list of package names/patterns to be filtered from the documentation.

Returns:

a map of BLangPackage objects. Key - Ballerina package name Value - BLangPackage

Throws:

IOException

generatePackageDocsFromBallerina

protected static Map<String,BLangPackage> generatePackageDocsFromBallerina(String sourceRoot,
                                                                           Path packagePath,
                                                                           String packageFilter,
                                                                           boolean isNative)
                                                                    throws IOException

Generates BLangPackage objects for each Ballerina package from the given ballerina files.

Parameters:

sourceRoot - points to the folder relative to which package path is given

packagePath - a Path object pointing either to a ballerina file or a folder with ballerina files.

packageFilter - comma separated list of package names/patterns to be filtered from the documentation.

isNative - whether the given packages are native or not.

Returns:

a map of BLangPackage objects. Key - Ballerina package name Value - BLangPackage

Throws:

IOException