scaladoc(1)

1scaladoc(1)                      USER COMMANDS                     scaladoc(1)
2
3
4

NAME

6       scaladoc - Documentation generator for the Scala 2 language
7

SYNOPSIS

9       scaladoc  [ <options> ] <source files>
10

PARAMETERS

12       <options>
13              Command line options. See OPTIONS below.
14
15       <source files>
16              One or more source files to be compiled (such as MyClass.scala).
17

DESCRIPTION

19       The  scaladoc  tool  reads class and object definitions, written in the
20       Scala 2 programming language, and generates their API as HTML files.
21
22       By default, the generator puts each HTML file in the same directory  as
23       its  source file. You can specify a separate destination directory with
24       -d (see OPTIONS, below).
25
26       The recognised format of comments in source is described in the  online
27       documentation
28

OPTIONS

30   Standard Options
31       -d <directory>
32              Specify where to generate documentation.
33
34       -version
35              Print product version and exit.
36
37       -help  Print a synopsis of available options.
38
39   Documentation Options
40       -doc-title <title>
41              Define  the  overall  title  of the documentation, typically the
42              name of the library being documented.
43
44       -doc-version <version>
45              Define the overall version number of  the  documentation,  typi‐
46              cally the version of the library being documented.
47
48       -doc-source-url <url>
49              Define  a  URL to be concatenated with source locations for link
50              to source files.
51
52   Compiler Options
53       -verbose
54              Output messages about what the compiler is doing
55
56       -deprecation
57              Indicate whether source  should  be  compiled  with  deprecation
58              information;  defaults to off (accepted values are: on, off, yes
59              and no)
60
61              Available since Scala version 2.2.1
62
63       -classpath <path>
64              Specify where to find user class files (on Unix-based systems  a
65              colon-separated list of paths, on Windows-based systems, a semi‐
66              colon-separate list of paths). This does not override the built-
67              in ("boot") search path.
68
69              The  default  class  path  is the current directory. Setting the
70              CLASSPATH variable or using the -classpath  command-line  option
71              overrides  that  default,  so if you want to include the current
72              directory in the search path, you must include "."  in  the  new
73              settings.
74
75       -sourcepath <path>
76              Specify where to find input source files.
77
78       -bootclasspath <path>
79              Override  location  of  bootstrap class files (where to find the
80              standard built-in classes, such as "scala.List").
81
82       -extdirs <dirs>
83              Override location of installed extensions.
84
85       -encoding <encoding>
86              Specify character encoding used by source files.
87
88              The default value is platform-specific (Linux: "UTF8",  Windows:
89              "Cp1252"). Executing the following code in the Scala interpreter
90              will return the default value on your system:
91
92                  scala> new java.io.InputStreamReader(System.in).getEncoding
93

EXIT STATUS

95       scaladoc returns a zero exist status if  it  succeeds  to  process  the
96       specified input files. Non zero is returned in case of failure.
97

AUTHORS

99       This  version of Scaladoc was written by Gilles Dubochet with contribu‐
100       tions by Pedro Furlanetto and Johannes Rudolph.  It  is  based  on  the
101       original Scaladoc (Sean McDirmid, Geoffrey Washburn, Vincent Cremet and
102       St?phane Michleoud), on vScaladoc (David Bernard), as  well  as  on  an
103       unreleased version of Scaladoc 2 (Manohar Jonnalagedda).
104