- About Scala
- Documentation
- Code Examples
- Software
- Scala Developers
Scaladoc: Identity Confusion; -linksource Problem
Sat, 2009-03-21, 00:16
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
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: