1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
.\" ##########################################################################
.\" # __ #
.\" # ________ ___ / / ___ Scala 2 On-line Manual Pages #
.\" # / __/ __// _ | / / / _ | (c) 2002-2007, LAMP/EPFL #
.\" # __\ \/ /__/ __ |/ /__/ __ | #
.\" # /____/\___/_/ |_/____/_/ | | http://scala-lang.org/ #
.\" # |/ #
.\" ##########################################################################
.\"
.\" Process this file with nroff -man scala.1
.\"
.TH scaladoc 1 "May 1, 2007" "version 0.4" "USER COMMANDS"
.\"
.\" ############################## NAME ###############################
.\"
.SH NAME
.PP
\fBscaladoc\fR \- Documentation generator for the Scala 2 language
.\"
.\" ############################## SYNOPSIS ###############################
.\"
.SH SYNOPSIS
.PP
\fBscaladoc\fR [ <\fIoptions\fR> ] <\fIsource files\fR>
.\"
.\" ############################## PARAMETERS ###############################
.\"
.SH PARAMETERS
.PP
.TP
<\fIoptions\fR>
Command line options. See \fBOPTIONS\fR below.
.TP
<\fIsource files\fR>
One or more source files to be compiled (such as MyClass.scala).
.\"
.\" ############################## DESCRIPTION ###############################
.\"
.SH DESCRIPTION
.PP
The \fBscaladoc\fR tool reads class and object definitions, written in the Scala 2 programming language, and generates their API as HTML files.
.PP
By default, the generator puts each HTML file in the same directory as its source file. You can specify a separate destination directory with \fB\-d\fR (see \fBOPTIONS\fR, below).
.PP
Supported tag comments are:
.IP
@author
.IP
@deprecated
.IP
@exception (two arguments)
.IP
@param (two arguments)
.IP
@pre
.IP
@return
.IP
@see
.IP
@since
.IP
@throws (two arguments)
.IP
@todo
.IP
@version
.PP
See also online document "How to Write Doc Comments for the Javadoc Tool" from Sun.
.\"
.\" ############################## OPTIONS ###############################
.\"
.SH OPTIONS
.PP
The generator has a set of standard options that are supported on the current development environment and will be supported in future releases.
.\"
.\" ############################## Standard Options ###############################
.\"
.SS "Standard Options"
.PP
.TP
\fB\-d\fR <\fIdirectory\fR>
Specify where to place generated class files.
.TP
\fB\-access:<access>\fR
Show only public, protected/public (default) or all classes and members (public,protected,private)
.TP
\fB\-windowtitle\fR <\fIwindowtitle\fR>
Specify window title of generated HTML documentation
.TP
\fB\-doctitle\fR <\fIdoctitle\fR>
Include title for the overview page
.TP
\fB\-stylesheetfile\fR <\fIstylesheetfile\fR>
File to change style of the generated documentation
.TP
\fB\-header\fR <\fIpageheader\fR>
Include header text for each page
.TP
\fB\-footer\fR <\fIpagefooter\fR>
Include footer text for each page
.TP
\fB\-top\fR <\fIpagetop\fR>
Include top text for each page
.TP
\fB\-bottom\fR <\fIpagebottom\fR>
Include bottom text for each page
.TP
\fB\-version\fR
Print product version and exit.
.TP
\fB\-help\fR
Print a synopsis of standard options.
.\"
.\" ############################## EXAMPLES ###############################
.\"
.SH EXAMPLES
.PP
.TP
Generate documentation for a Scala program
\fBscaladoc\fR HelloWorld.scala
.TP
Generation documentation for a Scala program to the destination directory \fBclasses\fR
\fBscaladoc\fR \fB\-d\fR api HelloWorld.scala
.TP
Generate documentation for all Scala files found in the source directory \fBsrc\fR to the destination directory \fBapi\fR
\fBscaladoc\fR \fB\-d\fR api src/*.scala
.\"
.\" ############################## EXIT STATUS ###############################
.\"
.SH "EXIT STATUS"
.PP
\fBscaladoc\fR returns a zero exist status if it succeeds to process the specified input files. Non zero is returned in case of failure.
.\"
.\" ############################## AUTHOR ###############################
.\"
.SH AUTHOR
.PP
Written by Martin Odersky and other members of the Scala team.
.\"
.\" ############################## REPORTING BUGS ###############################
.\"
.SH "REPORTING BUGS"
.PP
Report bugs to <scala@listes.epfl.ch>.
.\"
.\" ############################## COPYRIGHT ###############################
.\"
.SH COPYRIGHT
.PP
This is open-source software, available to you under a BSD-like license. See accomponying "copyright" or "LICENSE" file for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.\"
.\" ############################## SEE ALSO ###############################
.\"
.SH "SEE ALSO"
.PP
\fBfsc\fR(1), \fBsbaz\fR(1), \fBscala\fR(1), \fBscalac\fR(1), \fBscalap\fR(1)
|
