This page is no longer maintained — Please continue to the home page at www.scala-lang.org

Scaladoc: Identity Confusion; -linksource Problem

1 reply
Randall R Schulz
Joined: 2008-12-16,
User offline. Last seen 1 year 29 weeks ago.

Hi,

I'm trying to use scaladoc for the first time, so I ran it with
the "-help" option. This is what it showed me:

% scaladoc -help
Usage: scalac
where possible standard options include:
...

Why is it identifying itself as "scalac"? Just an oversight? Or does
scaladoc actually build on scalac?

Many of the options listed seem not to be relevant to generating
documentation and some are overtly rejected (-sourcepath, e.g.),
though are clearly documentation-specific.

Secondly, when I use "-linksource" the source links just point
to the type's HTML documentation page, not to a source
page as they do for, say, the on-line ScalaDoc pages at
.

Is there a trick I don't understand? Here's the invocation I'm using:

cd $PROJ_DOC/scaladoc

scaladoc \
-classpath $CLASSPATH \
-linksource \
$(find $PROJ_SRC -name '*.scala') \
2>&1 \
|tee $PROJ_DOC/sd-out

PROJ_DOC is a directory where documentation goes
PROJ_SRC is the base of the source directories

No diagnostic output is produced by this invocation.

Randall Schulz

manojo
Joined: 2008-12-22,
User offline. Last seen 3 years 3 weeks ago.
Re: Scaladoc: Identity Confusion; -linksource Problem
Hello,

I normally use

scaladoc -d directoryToOutput file1.scala file2.scala etc.

this will produce an index.html file in directoryToOutput normally.

Cheers,
Manojo

On Sat, Mar 21, 2009 at 1:16 AM, Randall R Schulz <rschulz@sonic.net> wrote:
Hi,

I'm trying to use scaladoc for the first time, so I ran it with
the "-help" option. This is what it showed me:

% scaladoc -help
Usage: scalac <options> <source files>
where possible standard options include:
...

Why is it identifying itself as "scalac"? Just an oversight? Or does
scaladoc actually build on scalac?

Many of the options listed seem not to be relevant to generating
documentation and some are overtly rejected (-sourcepath, e.g.),
though are clearly documentation-specific.


Secondly, when I use "-linksource" the source links just point
to the type's HTML documentation page, not to a source
page as they do for, say, the on-line ScalaDoc pages at
<http://www.scala-lang.org/docu/files/api/index.html>.

Is there a trick I don't understand? Here's the invocation I'm using:

   cd $PROJ_DOC/scaladoc

   scaladoc \
       -classpath $CLASSPATH \
       -linksource \
       $(find $PROJ_SRC -name '*.scala') \
       2>&1 \
      |tee $PROJ_DOC/sd-out


PROJ_DOC is a directory where documentation goes
PROJ_SRC is the base of the source directories

No diagnostic output is produced by this invocation.


Randall Schulz

Copyright © 2012 École Polytechnique Fédérale de Lausanne (EPFL), Lausanne, Switzerland