io7m | single-page | multi-page | epub | Cedarbridge User Manual 1.0.0-beta0001
4.3. compile
Previous
4. Command-Line Interface
Up
4.5. list-code-generators
Next

# 4.4. document

- 4.4.1. Name
- 4.4.2. Description
- 4.4.3. Examples

## 4.4.1. Name

1
document - Generate documentation for cedarbridge sources

## 4.4.2. Description

1
The document command generates documentation for cedarbridge sources.

### 4.4.2.2. Parameters

Parameter | Type | Required | Description
--- | --- | --- | ---
--verbose | CLPLogLevel | false | Set the minimum logging verbosity level.
--file | List | false | The file(s) to type-check
--include | List | false | The directories containing source files
--output-directory | Path | true | The output directory containing generated files
--no-core | boolean | false | Disable registration of the core com.io7m.cedarbridge package
--language | String | true | The language name used to select a documentation generator

## 4.4.3. Examples

### 4.4.3.1. Example

    $ cedarbridge document --file invalid.cbs --language 'xhtml'
    ERROR: invalid.cbs:3:1: Name "T" has already been defined.
      Specification: https://www.io7m.com/software/cedarbridge/specification/index.xhtml#id_1cf38aec-7544-4b5e-a5ac-bb01567ffe77
    (record T))
    ^
      See invalid.cbs:2:1:
    (record T))
    ^

    $ cedarbridge document --file valid.cbs --language 'xhtml'

4.3. compile
Previous
4. Command-Line Interface
Up
4.5. list-code-generators
Next
io7m | single-page | multi-page | epub | Cedarbridge User Manual 1.0.0-beta0001