scaladoc
– Documentation generator for the Scala 2 language
scaladoc
[ <options> ] <source files>
<options>
<source files>
MyClass.scala
).
The scaladoc
tool reads class and object definitions, written in the Scala 2 programming language, and generates their API as HTML files.
By default, the generator puts each HTML file in the same directory as its source file. You can specify a separate destination directory with –d
(see OPTIONS, below).
Supported tag comments are:
@author
@deprecated
@exception
(two arguments)@param
(two arguments)@pre
@return
@see
@since
@throws
(two arguments)@todo
@version
See also online document "How to Write Doc Comments for the Javadoc Tool" from Sun.
The generator has a set of standard options that are supported on the current development environment and will be supported in future releases.
–d <directory>
–access:<access>
public
,protected,private)–windowtitle <windowtitle>
–doctitle <doctitle>
–stylesheetfile <stylesheetfile>
–header <pageheader>
–footer <pagefooter>
–top <pagetop>
–bottom <pagebottom>
–version
–help
scaladoc
HelloWorld.scala
scaladoc
–d api
HelloWorld.scalascaladoc
–d api
src/*.scala
scaladoc
returns a zero exist status if it succeeds to process the specified input files. Non zero is returned in case of failure.
Written by Martin Odersky and other members of the Scala team.
Report bugs to <scala@listes.epfl.ch>
.
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.
fsc(1), sbaz(1), scala(1), scalac(1), scalap(1)