Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
docs
src
tools/monaco-dist
.gitignore
LICENSE
README.md
build.gradle
pom.xml
spotbugs-exclude.xml

README.md

Docerina

Jenkins: Build Status
Travis CI: Build Status

Docerina is the API documentation generator tool of the Ballerina language. Currently API documentation is generated in HTML format and it can be extended to support additional formats as required.

Supported Annotations

Please refer to Docerina Annotations guide.

Generating Ballerina API Documentation

Docerina is distributed with Ballerina Tools Distribution and [Docerina Maven Plugin] (https://github.com/ballerinalang/plugin-maven/tree/master/docerina-maven-plugin).

Using Ballerina Tools Distribution

Ballerina doc command can be used to generate the API documentation for your Ballerina programs.

$ ballerina doc --help
generate Ballerina API documentation

Usage:
ballerina doc <sourcepath>... [-t templatesdir] [-o outputdir] [-n] [-e excludedmodules] [-v]
  sourcepath:
  Paths to the directories where Ballerina source files reside or a path to
  a Ballerina file which does not belong to a module

Flags:
  --template, -t   path to a custom templates directory to be used for API documentation generation
  --output, -o     path to the output directory where the API documentation will be written to
  --native, -n     read the source as native ballerina code
  --exclude, -e    a comma separated list of module names to be filtered from the documentation
  --verbose, -v    enable debug level logs

Usage

Example 1: Generate API documentation for the given Ballerina source directories and files. This would generate API documentation at {currentdir}/api-docs/html/ directory:

$ ballerina doc ../../../connectors/twitter/src/ ../../../connectors/soap/src/ test.bal

Example 2: Generate API documentation for the given Ballerina source directories and files and copy them to the {currentdir}/docs directory:

$ ballerina doc ../../../connectors/twitter/src/ ../../../connectors/soap/src/ test.bal  -o docs

Example 3: Generate API documentation for the given Ballerina source directories and files, excluding org.wso2.ballerina.connectors.twitter module and copy them to the {currentdir}/docs directory:

$ ballerina doc ../../../connectors/twitter/src/ ../../../connectors/soap/src/ test.bal  -o docs -e org.wso2.ballerina.connectors.twitter

Example 4: Generate API documentation for the given Ballerina source directories and files and copy them to the {currentdir}/docs directory while printing debug level logs of Docerina to the STDOUT:

$ ballerina doc ../../../connectors/twitter/src/ ../../../connectors/soap/src/ test.bal  -o docs -v

Example 5: Generate API documentation for the given native Ballerina source directories:

$ ballerina doc ../../../connectors/twitter/src/ ../../../connectors/soap/src/ -n

Example 6: Generate API documentation using a custom templates folder:

$ ballerina doc ../../../connectors/twitter/src/ ../../../connectors/soap/src/ -t custom-templates

Using Docerina Maven Plugin

The Docerina Maven plugin is used to generate Ballerina API documentation at the build time of a Ballerina Module.

Introduction

The Docerina Maven plugin is a Maven plugin, which is used within the Ballerina language eco-system. The Maven goals that are achieved through this plugin are explained below:

This goal is executed during the compile phase in the default life cycle of the Maven build. You have the flexibility to configure the behavior of the plugin by passing the relevant parameters to this Maven goal.

Configuring Docerina Maven Goal

A sample pom.xml file configuration of the docerina Maven goal is shown below.

<build>
  <plugins>
      <plugin>
            <groupId>org.ballerinalang</groupId>
            <artifactId>docerina-maven-plugin</artifactId>
            <version>${docerina.maven.plugin.version}</version>
            <executions>
                <execution>
                    <phase>compile</phase>
                    <goals>
                        <goal>docerina</goal>
                    </goals>
                    <configuration>
                        <outputDir>${output.dir}</outputDir>
                        <sourceDir>${generated.ballerina.source.directory}</sourceDir>
                        <templatesDir>/home/docerina/templates</templatesDir>
                        <packageFilter>org.ballerinalang.xyz</packageFilter>
                        <debugDocerina>false</debugDocerina>
                        <nativeCode>false</nativeCode>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

Supported list of configuration parameters are listed below;

  • sourceDir: Comma separated list of the paths to the directories where Ballerina source files reside or paths to Ballerina files which does not belong to a module.

MANDATORY property. Example: <sourceDir>/home/docerina/abc/src,/home/docerina/xyz/src</sourceDir>

  • outputDir: Points to the location where the generated API docs will be stored.

OPTIONAL property. DEFAULT value is the ${project.build.directory} which is the target directory. Example: <outputDir>/home/docerina/output</outputDir>

  • templatesDir: Points to a custom templates directory.

OPTIONAL property. DEFAULT value is the embedded templates folder. Example: <templatesDir>/home/docerina/templates</templatesDir>

  • packageFilter: Comma separated list of module names to be filtered from the documentation.

OPTIONAL property. DEFAULT value is none. Example: <packageFilter>org.ballerinalang.abc.a,org.ballerinalang.xyz.x</packageFilter>

  • debugDocerina: Enable debug level logs.

OPTIONAL property. DEFAULT value is false. Example: <debugDocerina>true</debugDocerina>

  • nativeCode: Treat the source as native ballerina code.

OPTIONAL property. DEFAULT value is false. Example: <nativeCode>true</nativeCode>

Setting up a Docerina Development Environment

Follow below steps to setup a Docerina development environment:

  • Clone the Ballerina Git repository:

    git clone https://github.com/ballerinalang/ballerina
    
  • Build Ballerina and extract the distribution:

    cd ballerina
    mvn clean install
    cd modules/distribution/target/
    unzip ballerina-<version>.zip
    cd ballerina-<version> # Refer this as [ballerina-home]
    
  • Clone the Docerina Git repository:

    cd ..
    git clone https://github.com/ballerinalang/docerina.git
    
  • Build Docerina and copy the Docerina JAR file to the Ballerina distribution lib folder:

    cd docerina
    mvn clean install
    cd target
    cp docerina-<version>.jar [ballerina-home]/bre/lib/
    
  • Navigate to Ballerina bin directory and execute the bellow command to generate API documentation:

    cd [ballerina-home]/bin
    ./ballerina doc [ballerina-module-path] # absolute file path of the ballerina source module
    
  • Execute the below command to attach a remote debugging session to debug Docerina:

    cd [ballerina-home]/bin
      ./ballerina --debug 5005 doc [ballerina-module-path] # absolute file path of the ballerina source module
    
You can’t perform that action at this time.