Note: information on this page refers to Ceylon 1.1, not to the current release.

<ceylon-doc> Ant task

Usage

Note: You must declare the tasks with a <typedef>.

To compile the documentation for module com.example.foo whose source code is in the src directory to a module repository in the build directory:

<target name="documentation" depends="ceylon-ant-taskdefs">
  <ceylon-doc src="src" out="build">
    <module name="com.example.foo"/>
  </ceylon-doc>
</target>

To compile the documentation for version 1.1 of module com.example.foo whose source code is in the build directory to a module repository in the build directory:

<target name="documentation" depends="ceylon-ant-taskdefs">
  <ceylon-doc out="build">
    <module name="com.example.foo" version="1.1"/>
  </ceylon-doc>
</target>

Description

The <ceylon-doc> ant task supports documentation of Ceylon and Java source code to a Ceylon repository using the Ant build tool. It provides similar features to the ceylon doc command line tool.

Parameters

Note: In addition to the parameters in the table below table, a nested <module>(s) is required.

Attribute Description Required
src A source directory. No, default is source
encoding The character encoding used for source files No, default is the OS default encoding
out The output module repository (which must be publishable). No, default is modules
includeNonShared Whether to document non-shared declarations. No, default is false
includeSourceCode Whether to include the source code in the documentation. No, default is false
user The user name to use when connecting to the output repository. Only used for HTTP output repositories. No
pass The password to use when connecting to the output repository. Only used for HTTP output repositories. No
nomtimecheck Whether to perform a comparison of file modification times to determine whether to document a module. The most recent modification time of the source files is compared with the oldest modification time of the output artifacts. This can speed up builds when the source files have not changed but is not able to detect deletion of source files. No, default is false
executable The filesystem location of the ceylon command line tool. If not specified it is searched in the directory indicated by the ceylon.home system property, or if that is not set the CEYLON_HOME environment variable. No
verbose Whether the documentation generator should emit verbose logging information. The zero or more of the following flags can be passed separated by commas: 'all' or 'loader'. If you do not pass a flag 'all' will be assumed. No

Nested elements

Note: Unlike ant's <javadoc> task, <ceylond> does not support an implict FileSet so you cannot add <include>/<exclude> etc as direct subelements. You must use <files> explicitly.

<moduleset>

A reference to a <moduleset> defined elsewhere in the ant build file.

<module>

A module to document. Can be specified multiple times.

Attribute Description Required
name The module name Yes
version The module version. If no version identifier is specified for a module, the module is assumed to exist in a source directory. No

<reposet>

A reference to a <reposet> defined elsewhere in the ant build file.

<rep>

A module repository containing dependencies. Can be specified multiple times. Default to modules.

Attribute Description Required
url The URL of the module repository Yes

Output

The <ceylon-doc> task outputs a module documentation folder for each module named on the command line. The documentation generator produceds module-doc folders directly, in the output module repository.

See also