org.ballerinalang.docgen.docs.utils

Class BallerinaDocUtils

java.lang.Object

org.ballerinalang.docgen.docs.utils.BallerinaDocUtils

public class BallerinaDocUtils
extends Object

Util methods used for doc generation.

Constructor Summary

Constructors

Constructor and Description
BallerinaDocUtils()

Method Summary

Modifier and Type	Method and Description
static void	copyResources(String resource, String targetPath) Find a given resource and copy its content recursively to a given target path.
static String	getPrimitiveDescription(List<String> descriptions, String type)
static boolean	isDebugEnabled()
static List<String>	loadPrimitivesDescriptions(boolean filterDescription) Load primitive types of Ballerina.
static String	mdToHtml(String mdContent) Convert a given md to a html.
static void	packageToZipFile(String sourceDirPath, String zipFilePath)

Methods inherited from class java.lang.Object

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

Constructor Detail

BallerinaDocUtils

public BallerinaDocUtils()

Method Detail

mdToHtml

public static String mdToHtml(String mdContent)

Convert a given md to a html.

Parameters:

mdContent - content

Returns:

html representation

loadPrimitivesDescriptions

public static List<String> loadPrimitivesDescriptions(boolean filterDescription)

Load primitive types of Ballerina.

Returns:

a lit of primitive types and their corresponding descriptions.

packageToZipFile

public static void packageToZipFile(String sourceDirPath,
                                    String zipFilePath)
                             throws IOException

Throws:

IOException

copyResources

public static void copyResources(String resource,
                                 String targetPath)
                          throws IOException

Find a given resource and copy its content recursively to a given target path.

Parameters:

resource - name of the resource

targetPath - target directory path as a string.

Throws:

IOException - Failure to load the resources.

isDebugEnabled

public static boolean isDebugEnabled()

getPrimitiveDescription

public static String getPrimitiveDescription(List<String> descriptions,
                                             String type)