← Tools

cpl doc

build HTML documentation from `///` comments

usage: cpl doc [options] [path]...

Writes documentation for the declarations and `///` comments of every .cp
file given. A directory stands for every .cp file under it; no path at
all means the current directory.

options:
  --out DIR          where the site goes (default: target/doc)
  --format html      a static site: index.html and one page per file (default)
  --format json      one JSON document on stdout, for another generator
  --title TEXT       the site's name (default: Documentation)
  --source-url URL   link every item to URL/<path>#L<line>
  --test             check the examples in doc comments instead of writing docs

Generated from cpl 0.2.2 (dev, a0d0078e).