1scaladoc(1) USER COMMANDS scaladoc(1)
2
6 scaladoc - Documentation generator for the Scala 2 language
7
9 scaladoc [ <options> ] <source files>
10
12 <options>
13 Command line options. See OPTIONS below.
14 <source files>
16 One or more source files to be compiled (such as MyClass.scala).
17
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 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 The recognised format of comments in source is described in the online
27 documentation
28
30 Standard Options
31 -d <directory>
32 Specify where to generate documentation.
33 -version
35 Print product version and exit.
36 -help Print a synopsis of available options.
38 Documentation Options
40 -doc-title <title>
41 Define the overall title of the documentation, typically the
42 name of the library being documented.
43 -doc-version <version>
45 Define the overall version number of the documentation, typi‐
46 cally the version of the library being documented.
47 -doc-source-url <url>
49 Define a URL to be concatenated with source locations for link
50 to source files.
51 -doc-external-doc <external-doc>
53 Define a comma-separated list of classpath_entry_path#doc_URL
54 pairs describing external dependencies.
55 -jdk-api-doc-base <url>
57 Define a URL to be concatenated with source locations for link
58 to Java API.
59 Compiler Options
61 -verbose
62 Output messages about what the compiler is doing
63 -deprecation
65 Indicate whether source should be compiled with deprecation in‐
66 formation; defaults to off (accepted values are: on, off, yes
67 and no)
68 Available since Scala version 2.2.1
70 -classpath <path>
72 Specify where to find user class files (on Unix-based systems a
73 colon-separated list of paths, on Windows-based systems, a semi‐
74 colon-separate list of paths). This does not override the built-
75 in ("boot") search path.
76 The default class path is the current directory. Setting the
78 CLASSPATH variable or using the -classpath command-line option
79 overrides that default, so if you want to include the current
80 directory in the search path, you must include "." in the new
81 settings.
82 -sourcepath <path>
84 Specify where to find input source files.
85 -bootclasspath <path>
87 Override location of bootstrap class files (where to find the
88 standard built-in classes, such as "scala.List").
89 -extdirs <dirs>
91 Override location of installed extensions.
92 -encoding <encoding>
94 Specify character encoding used by source files.
95 The default value is platform-specific (Linux: "UTF8", Windows:
97 "Cp1252"). Executing the following code in the Scala REPL will
98 return the default value on your system:
99 scala> new java.io.InputStreamReader(System.in).getEncoding
101
103 scaladoc returns a zero exit status if it succeeds at processing the
104 specified input files. Non zero is returned in case of failure.
105
107 This version of Scaladoc was written by Gilles Dubochet with contribu‐
108 tions by Pedro Furlanetto and Johannes Rudolph. It is based on the
109 original Scaladoc (Sean McDirmid, Geoffrey Washburn, Vincent Cremet and
110 Stéphane Micheloud), on vScaladoc (David Bernard), as well as on an un‐
111 released version of Scaladoc 2 (Manohar Jonnalagedda).
112
114 fsc(1), scala(1), scalac(1), scalap(1)
115version 2.0 June 2010 scaladoc(1)