SYNOPSIS

golo doc [options] file …​

DESCRIPTION

Golo provides a support for documentation blocks on modules, functions, augmentations, structs and unions, as well as fields.

This command can render such documentation in the form of HTLM files (the default) or Markdown. In addition, it can produce a ctags tags file, to be used by editors such as Vim or emacs. In this mode, the special output target - can be used to print the tags on standard output, which is needed by some editors or extensions.

OPTIONS

--classpath path

Classpath elements (.jar and directories).

--format format

Documentation format to use. Can be 'html', 'markdown', 'ctags'. Defaults to 'html'.

--output directory

The documentation output directory. With 'ctags' format, '-' can be used for standard output (e.g. when executed in an editor). Defaults to the current directory.

Directories are traversed recursively.

DOCUMENTATION BLOCKS

Blocks are delimited by ---- and contain free-form Markdown text. The documentation block must be written right before the element to document. For instance:

----
This is a *nice* module that does a bunch of useless things.

See more at [our website](http://www.typeunsafe.org).
----
module Hello

----
Adds 2 elements, which is quite surprising given the name.

* `x` is the first argument,
* `y` is the second argument.

The following snipped prints `3`:

    let result = adder(1, 2)
    println(result)

Impressive!
----
function adder = |x, y| -> x + y

Sections can be added in the documentation using the normal markdown syntax. The level of the titles is adapted to the generated documentation.

BUGS

AUTHOR

See https://github.com/eclipse/golo-lang/graphs/contributors or the CONTRIBUTORS file in the golo source distribution.

This work is made available under the terms of the Eclipse Public License 2.0. See http://www.eclipse.org/legal/epl-2.0 or the LICENCE file in the golo source distribution.