eu.lindenbaum.maven.erlang
Class EDocScript

java.lang.Object
  eu.lindenbaum.maven.erlang.EDocScript

All Implemented Interfaces:

Script<Boolean>

public class EDocScript
extends Object

A Script generating edoc documentation for an application using edoc:application/3.

Author:

Tobias Schlager

Field Summary

protected String

script

Fields inherited from interface eu.lindenbaum.maven.erlang.Script

NL

Constructor Summary

EDocScript(String appName, File indir, File outdir, File overview)
Creates a Script that generates edoc documentation for a specfic application.

Method Summary

String	get() Returns an evaluateable String containing the erlang script of the implementing class.
Boolean	handle(com.ericsson.otp.erlang.OtpErlangObject result) Converts the result of the Script execution into a Boolean indicating success.

Methods inherited from class java.lang.Object

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

Field Detail

script

protected final String script

Constructor Detail

EDocScript

public EDocScript(String appName,
                  File indir,
                  File outdir,
                  File overview)
           throws org.apache.maven.plugin.MojoExecutionException

Creates a Script that generates edoc documentation for a specfic application.

Parameters:

appName - name of the application

indir - input directory that will be scanned recursively (where .erl files reside)

outdir - to put the documentation into

overview - location of the overview file

Throws:

org.apache.maven.plugin.MojoExecutionException

Method Detail

get

public String get()

Description copied from interface: Script

Returns an evaluateable String containing the erlang script of the implementing class.

Returns:

An erlang script that can be evaluated.

handle

public Boolean handle(com.ericsson.otp.erlang.OtpErlangObject result)

Converts the result of the Script execution into a Boolean indicating success.

Parameters:

result - the result term of the Script execution

Returns:

true on success, false otherwise