GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  CEYLON-DOC (1)

NAME

ceylon doc - Generates Ceylon API documentation from Ceylon source files

CONTENTS

Synopsis
Description
Options
Example
Repositories

SYNOPSIS

ceylon doc \kx [--browse] [--cacherep=url] [--cwd=dir] [--doc=dirs...] [--encoding=encoding] [--footer=footer] [--header=header] [--ignore-broken-link] [--ignore-missing-doc] [--ignore-missing-throws] [--link=dir-or-url...] [--maven-overrides=url] [--no-default-repositories] [--non-shared] [--offline] [--out=url] [--overrides=url] [--pass=secret] [--rep=url...] [--resource-folder=dir] [--source=dirs...] [--source-code] [--src=dir...] [--sysrep=url] [--timeout=seconds] [--user=name] [--verbose[=flags]] [--] [modules]...

DESCRIPTION

The default module repositories are modules and https://modules.ceylon-lang.org/repo/1, and the default source directory is source. The default output module repository is modules.

The <modules> are the names (with an optional version) of the modules to compile the documentation of.

The documentation compiler searches for compilation units belonging to the specified modules in the specified source directories and in source archives in the specified module repositories. For each specified module, the compiler generates a set of XHTML pages in the module documentation directory (the module-doc directory) of the specified output module repository.

The compiler searches for source in the following locations:
o source archives in the specified repositories, and
o module directories in the specified source directories.
If no version identifier is specified for a module, the module is assumed to exist in a source directory.

OPTIONS

--browse
  Open module documentation in browser.
--cacherep=url
  Specifies the folder to use for caching downloaded modules. (default: ~/.ceylon/cache)
--cwd=dir
  Specifies the current working directory for this tool. (default: the directory where the tool is run from)
--doc=dirs
  A directory containing your module documentation (default: ./doc)
--encoding=encoding
  Sets the encoding used for reading source files (default: platform-specific)
--footer=footer
  Sets the footer text to be placed at the bottom of each page.
--header=header
  Sets the header text to be placed at the top of each page.
--ignore-broken-link
  Do not print warnings about broken links.
--ignore-missing-doc
  Do not print warnings about missing documentation.
--ignore-missing-throws
  Do not print warnings about missing throws annotation.
--link=dir-or-url
  The URL or path of a module repository containing documentation for external dependencies.

The URL must use one of the supported protocols (http://, https:// or file://) or be a path to a directory. The argument can start with a module name prefix, separated from the URL by a = character, so that only those external modules whose name begins with the prefix will be linked using that URL. Can be specified multiple times.

Examples:

--link https://modules.ceylon-lang.org/repo/1
--link ceylon.math=https://modules.ceylon-lang.org/repo/1
--link com.example=http://example.com/ceylondoc/

--maven-overrides=url
  Specifies the XML file to use to load Maven artifact overrides. See http://ceylon-lang.org/documentation/current/reference/repository/maven/ for information. Deprecated: use --overrides.
--no-default-repositories
  Indicates that the default repositories should not be used.
--non-shared
  Includes documentation for package-private declarations.
--offline
  Enables offline mode that will prevent the module loader from connecting to remote repositories.
--out=url, -o url
  Specifies the output module repository (which must be publishable). (default: ./modules)
--overrides=url
  Specifies the XML file to use to load module overrides. See http://ceylon-lang.org/documentation/current/reference/repository/maven/ for information. Experimental.
--pass=secret
  Sets the password for use with an authenticated output repository (no default).
--rep=url
  Specifies a module repository containing dependencies. Can be specified multiple times. (default: modules, ~/.ceylon/repo, https://modules.ceylon-lang.org/repo/1)
--resource-folder=dir
  A directory name, where the documentation resources (css, js, ...) will be placed (default: .resources)
--source=dirs
  An alias for --src (default: ./source)
--source-code
  Includes source code in the generated documentation.
--src=dir
  A directory containing Ceylon and/or Java source code (default: ./source)
--sysrep=url
  Specifies the system repository containing essential modules. (default: $CEYLON_HOME/repo)
--timeout=seconds, -T seconds
  Sets the timeout for connections to remote repositories, use 0 for no timeout (default: 20).
--user=name
  Sets the user name for use with an authenticated output repository (no default).
--verbose[=flags], -d
  Produce verbose output. If no flags are given then be verbose about everything, otherwise just be verbose about the flags which are present. Allowed flags include: all, loader.

EXAMPLE

The following would compile the org.hibernate module source code found in the ~/projects/hibernate/src directory to the repository ~/projects/hibernate/build:

ceylon doc org.hibernate/3.0.0.beta \
    --src ~/projects/hibernate/src \
    --out ~/projects/hibernate/build

REPOSITORIES

Repositories like those specified with the --rep or --out options can be file paths, HTTP urls to remote servers or can be names of repositories when prepended with a + symbol. These names refer to repositories defined in the configuration file or can be any of the following predefined names +SYSTEM, +CACHE, +LOCAL, +USER or +REMOTE. For more information see http://ceylon-lang.org/documentation/1.0/reference/tool/config
Search for    or go to Top of page |  Section 1 |  Main Index


CEYLON DOC (1) 10 February 2016

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.