"Fossies" - the Fresh Open Source Software Archive

Member "scala-2.13.9/doc/tools/scaladoc.html" (19 Sep 2022, 6524 Bytes) of package /windows/misc/scala-2.13.9.zip:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

A hint: This file contains one or more very long lines, so maybe it is better readable using the pure text view mode that shows the contents as wrapped lines within the browser window.


    1 <?xml version="1.1" encoding="iso-8859-1"?>
    2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
    3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    4 
    5 <head>
    6 <title>scaladoc man page</title>
    7 <meta http-equiv="Content-Language" content="en"/>
    8 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
    9 <meta name="Author" content="Gilles Dubochet"/>
   10 <style type="text/css">
   11   <!--
   12   blockquote, pre { margin:1em 4em 1em 4em; }
   13   dt { margin: 0.6em 0 0 0; }
   14   p { margin:0.6em 2em 0.6em 2em; text-align:justify; }
   15   //-->
   16 </style>
   17 </head>
   18 
   19 <body>
   20 <!-- header -->
   21 <div style="margin: 0 0 2em 0;">
   22 <div style="float:left;">
   23 scaladoc(1)
   24 </div>
   25 <div style="float:right;">
   26 scaladoc(1)
   27 </div>
   28 <div style="text-align:center;">
   29 USER COMMANDS
   30 </div>
   31 </div>
   32 
   33 <h3 id="name">NAME</h3>
   34 <p>
   35 <code><b>scaladoc</b></code> &#8211; Documentation generator for the <a href="https://scala-lang.org/">Scala 2</a> language</p>
   36 
   37 <h3 id="synopsis">SYNOPSIS</h3>
   38 <p>
   39 <code><b>scaladoc</b></code><code>  [ &lt;<i>options</i>&gt; ] &lt;<i>source files</i>&gt;</code></p>
   40 
   41 <h3 id="parameters">PARAMETERS</h3>
   42 <p>
   43 <ins><dl>
   44 <dt>
   45 <code>&lt;<i>options</i>&gt;</code>
   46 </dt>
   47 <dd>
   48 Command line options. See <a href="#options"><b>OPTIONS</b></a> below.</dd>
   49 <dt>
   50 <code>&lt;<i>source files</i>&gt;</code>
   51 </dt>
   52 <dd>
   53 One or more source files to be compiled (such as <code>MyClass.scala</code>).</dd>
   54 </dl></ins>
   55 </p>
   56 
   57 <h3 id="description">DESCRIPTION</h3>
   58 <p>
   59 The <code><b>scaladoc</b></code> tool reads class and object definitions, written in the <a href="https://scala-lang.org/">Scala 2</a> programming language, and generates their API as HTML files.</p>
   60 <p>
   61 By default, the generator puts each HTML file in the same directory as its source file. You can specify a separate destination directory with <code><b>&#8211;d</b> </code>(see <a href="#options"><b>OPTIONS</b></a>, below).</p>
   62 <p>
   63 The recognised format of comments in source is described in the <a href="https://wiki.scala-lang.org/display/SW/Scaladoc">online documentation</a></p>
   64 
   65 <h3 id="options">OPTIONS</h3>
   66 
   67 <h4 id="standard_options">Standard Options</h4>
   68 <p>
   69 <ins><dl>
   70 <dt>
   71 <code><b>&#8211;d</b> &lt;<i>directory</i>&gt; </code>
   72 </dt>
   73 <dd>
   74 Specify where to generate documentation.</dd>
   75 <dt>
   76 <code><b>&#8211;version</b> </code>
   77 </dt>
   78 <dd>
   79 Print product version and exit.</dd>
   80 <dt>
   81 <code><b>&#8211;help</b> </code>
   82 </dt>
   83 <dd>
   84 Print a synopsis of available options.</dd>
   85 </dl></ins>
   86 </p>
   87 
   88 <h4 id="documentation_options">Documentation Options</h4>
   89 <p>
   90 <ins><dl>
   91 <dt>
   92 <code><b>&#8211;doc-title</b> &lt;<i>title</i>&gt; </code>
   93 </dt>
   94 <dd>
   95 Define the overall title of the documentation, typically the name of the library being documented.</dd>
   96 <dt>
   97 <code><b>&#8211;doc-version</b> &lt;<i>version</i>&gt; </code>
   98 </dt>
   99 <dd>
  100 Define the overall version number of the documentation, typically the version of the library being documented.</dd>
  101 <dt>
  102 <code><b>&#8211;doc-source-url</b> &lt;<i>url</i>&gt; </code>
  103 </dt>
  104 <dd>
  105 Define a URL to be concatenated with source locations for link to source files.</dd>
  106 <dt>
  107 <code><b>&#8211;doc-external-doc</b> &lt;<i>external-doc</i>&gt; </code>
  108 </dt>
  109 <dd>
  110 Define a comma-separated list of classpath_entry_path#doc_URL pairs describing external dependencies.</dd>
  111 <dt>
  112 <code><b>&#8211;jdk-api-doc-base</b> &lt;<i>url</i>&gt; </code>
  113 </dt>
  114 <dd>
  115 Define a URL to be concatenated with source locations for link to Java API.</dd>
  116 </dl></ins>
  117 </p>
  118 
  119 <h4 id="compiler_options">Compiler Options</h4>
  120 <p>
  121 <ins><dl>
  122 <dt>
  123 <code><b>&#8211;verbose</b> </code>
  124 </dt>
  125 <dd>
  126 Output messages about what the compiler is doing</dd>
  127 <dt>
  128 <code><b>&#8211;deprecation</b> </code>
  129 </dt>
  130 <dd>
  131 <div>
  132 Indicate whether source should be compiled with deprecation information; defaults to <code>off</code> (accepted values are: <code>on</code>, <code>off</code>, <code>yes</code> and <code>no</code>)
  133 </div>
  134 <div>
  135 Available since Scala version 2.2.1
  136 </div>
  137 </dd>
  138 <dt>
  139 <code><b>&#8211;classpath</b> &lt;<i>path</i>&gt; </code>
  140 </dt>
  141 <dd>
  142 <div>
  143 Specify where to find user class files (on Unix-based systems a colon-separated list of paths, on Windows-based systems, a semicolon-separate list of paths). This does not override the built-in (<code>"boot"</code>) search path.
  144 </div>
  145 <div>
  146 The default class path is the current directory. Setting the <code>CLASSPATH</code> variable or using the <code>-classpath</code> command-line option overrides that default, so if you want to include the current directory in the search path, you must include <code>"."</code> in the new settings.
  147 </div>
  148 </dd>
  149 <dt>
  150 <code><b>&#8211;sourcepath</b> &lt;<i>path</i>&gt; </code>
  151 </dt>
  152 <dd>
  153 Specify where to find input source files.</dd>
  154 <dt>
  155 <code><b>&#8211;bootclasspath</b> &lt;<i>path</i>&gt; </code>
  156 </dt>
  157 <dd>
  158 Override location of bootstrap class files (where to find the standard built-in classes, such as "<code>scala.List</code>").</dd>
  159 <dt>
  160 <code><b>&#8211;extdirs</b> &lt;<i>dirs</i>&gt; </code>
  161 </dt>
  162 <dd>
  163 Override location of installed extensions.</dd>
  164 <dt>
  165 <code><b>&#8211;encoding</b> &lt;<i>encoding</i>&gt; </code>
  166 </dt>
  167 <dd>
  168 <div>
  169 Specify character encoding used by source files.
  170 </div>
  171 <div>
  172 The default value is platform-specific (Linux: <code>"UTF8"</code>, Windows: <code>"Cp1252"</code>). Executing the following code in the Scala REPL will return the default value on your system:
  173 </div>
  174 <div>
  175 <code><b>    scala&gt; </b></code><code>new java.io.InputStreamReader(System.in).getEncoding</code>
  176 </div>
  177 </dd>
  178 </dl></ins>
  179 </p>
  180 
  181 <h3 id="exit_status">EXIT STATUS</h3>
  182 <p>
  183 <code><b>scaladoc</b></code> returns a zero exit status if it succeeds at processing the specified input files. Non zero is returned in case of failure.</p>
  184 
  185 <h3 id="authors">AUTHORS</h3>
  186 <p>
  187 This version of Scaladoc was written by Gilles Dubochet with contributions by Pedro Furlanetto and Johannes Rudolph. It is based on the original Scaladoc (Sean McDirmid, Geoffrey Washburn, Vincent Cremet and St├ęphane Micheloud), on vScaladoc (David Bernard), as well as on an unreleased version of Scaladoc 2 (Manohar Jonnalagedda).</p>
  188 
  189 <h3 id="see_also">SEE ALSO</h3>
  190 <p>
  191 <a href="fsc.html"><b>fsc</b>(1)</a>, <a href="scala.html"><b>scala</b>(1)</a>, <a href="scalac.html"><b>scalac</b>(1)</a>, <a href="scalap.html"><b>scalap</b>(1)</a></p>
  192 <!-- footer -->
  193 <div style="margin: 2em 0 0 0;">
  194 <div style="float:left;">
  195 version 2.0
  196 </div>
  197 <div style="float:right;">
  198 scaladoc(1)
  199 </div>
  200 <div style="text-align:center;">
  201 June 2010
  202 </div>
  203 </div>
  204 </body>
  205 </html>