scaladoc bugfixes

Have you try vscaladoc ?
http://code.google.com/p/vscaladoc/

A new version of vscaladoc will be released soon (next week I hope).
fill issue, and may be I could include them in the future release or the next-next one

/davidB

On Wed, Feb 18, 2009 at 13:51, Normen Müller <n.mueller@jacobs-university.de> wrote:

He,

I just wondered on the prioritization of scaladoc bug fixing.

In the project we are developing on, we have to do a lot of documentation including API documentation.  Unfortunately not all scaladoc features compared to javadoc work properly or are just not yet supported.

Are there any planes for the next scala release?

Cheers,
--
Normen Müller

On Feb 18, 2009, at 2:32 PM, David Bernard wrote:
> Have you try vscaladoc ?
> http://code.google.com/p/vscaladoc/

Is it possible to easy use vscaladoc with ant? Cause I am not using
maven. If it is possible, I'd love to do so and file potential bugs.

Cheers,
--
Normen Müller

Currenlty there is not antlib nor task for ant. so it's harder than with maven  or with the scaladoc ant task but not impossible (I just add a task in the issue tracker for that).
 you could try to adapt the this sample shell script (the biggest part is to provide the list of all scala files to parse).

mkdir -p target/site/scaladocs


java -classpath $REPO/org/scala-lang/scala-dbc/$SCALA_VERSION/scala-dbc-$SCALA_VERSION.jar:$REPO/org/scala-lang/scala-library/$SCALA_VERSION/scala-library-$SCALA_VERSION.jar:$REPO/org/scala-lang/scala-compiler/$SCALA_VERSION/scala-compiler-$SCALA_VERSION.jar:$REPO/org/scala-lang/scala-decoder/$SCALA_VERSION/scala-decoder-$SCALA_VERSION.jar:$REPO/org/scala-tools/vscaladoc/1.0-SNAPSHOT/vscaladoc-1.0-SNAPSHOT.jar -Xbootclasspath/a:$REPO/org/scala-lang/scala-library/$SCALA_VERSION/scala-library-$SCALA_VERSION.jar org.scala_tools.vscaladoc.Main -Ydoc -classpath ./target/classes:$REPO/org/scala-lang/scala-library/$SCALA_VERSION/scala-library-$SCALA_VERSION.jar:$REPO/org/scala-lang/scala-vscala$SCALA_VERSION/scala-compiler-$SCALA_VERSION.jar -d ./target/site/scaladocs -sourcepath ./src/main/scala ./src/main/scala/org/scala_tools/vscaladoc/demo/DemoA.scala ./src/main/scala/org/scala_tools/vscaladoc/demo/DemoB.scala

Sorry,

PS: If someone already created a anttask or the xml fragment to call vscaladoc, please share/send us


On Wed, Feb 18, 2009 at 17:28, Normen Müller <n.mueller@jacobs-university.de> wrote:

On Feb 18, 2009, at 2:32 PM, David Bernard wrote:

Have you try vscaladoc ?
http://code.google.com/p/vscaladoc/

Is it possible to easy use  vscaladoc with ant?  Cause I am not using maven.  If it is possible, I'd love to do so and file potential bugs.

Cheers,
--
Normen Müller

On Feb 18, 2009, at 5:47 PM, David Bernard wrote:
> you could try to adapt this sample shell script (the biggest part is
> to provide the list of all scala files to parse).
> mkdir -p target/site/scaladocs
>
>
> java -classpath $REPO/org/scala-lang/scala-dbc/$SCALA_VERSION/scala-
> dbc-$SCALA_VERSION.jar:$REPO/org/scala-lang/scala-library/
> $SCALA_VERSION/scala-library-$SCALA_VERSION.jar:$REPO/org/scala-lang/
> scala-compiler/$SCALA_VERSION/scala-compiler-$SCALA_VERSION.jar:
> $REPO/org/scala-lang/scala-decoder/$SCALA_VERSION/scala-decoder-
> $SCALA_VERSION.jar:$REPO/org/scala-tools/vscaladoc/1.0-SNAPSHOT/
> vscaladoc-1.0-SNAPSHOT.jar -Xbootclasspath/a:$REPO/org/scala-lang/
> scala-library/$SCALA_VERSION/scala-library-$SCALA_VERSION.jar
> org.scala_tools.vscaladoc.Main -Ydoc -classpath ./target/classes:
> $REPO/org/scala-lang/scala-library/$SCALA_VERSION/scala-library-
> $SCALA_VERSION.jar:$REPO/org/scala-lang/scala-vscala$SCALA_VERSION/
> scala-compiler-$SCALA_VERSION.jar -d ./target/site/scaladocs -
> sourcepath ./src/main/scala ./src/main/scala/org/scala_tools/
> vscaladoc/demo/DemoA.scala ./src/main/scala/org/scala_tools/
> vscaladoc/demo/DemoB.scala
Isn't this script a bit outdated? I haven't tried it out yet,
though. For example, $SCALA_VERSION shouldn't be needed anymore and "-
Ydoc" doesn't work as far as I remember. Don't you have something
more sophisticated or do you mainly support maven? With
``sophisticated'' I definitely don't want to put any pressure on you,
but I am just asking for a more clever shell script, like one figuring
out the files to parse by passing a directory on the command line ...
stuff like that. I just think that with such support more people
could easily use vscaladoc (just my 2ct).

Cheers,
--
Normen Müller

* $SCALA_VERSION is used in my script because I add version number to every jar (and in this case I use jar from a maven repository)
* -Ydoc is outdated only for scala 2.7.2+ vscaladoc work with 2.7.0+, this trick is managed by the maven plugin (so I forgot it everytime)
* listing every .scala file is inherited from scalac that require this (it's hidden by ant and maven), this should be fix in the next release of vscaladoc and a ticket was created/accepted for scala-2.8

I agree that a more friendly command line version (and an ant task) will be a plus (including the ability to not list every .scala)

/davidB

On Wed, Feb 18, 2009 at 23:09, Normen Müller <n.mueller@jacobs-university.de> wrote:

On Feb 18, 2009, at 5:47 PM, David Bernard wrote:

you could try to adapt this sample shell script (the biggest part is to provide the list of all scala files to parse).
mkdir -p target/site/scaladocs


java -classpath $REPO/org/scala-lang/scala-dbc/$SCALA_VERSION/scala-dbc-$SCALA_VERSION.jar:$REPO/org/scala-lang/scala-library/$SCALA_VERSION/scala-library-$SCALA_VERSION.jar:$REPO/org/scala-lang/scala-compiler/$SCALA_VERSION/scala-compiler-$SCALA_VERSION.jar:$REPO/org/scala-lang/scala-decoder/$SCALA_VERSION/scala-decoder-$SCALA_VERSION.jar:$REPO/org/scala-tools/vscaladoc/1.0-SNAPSHOT/vscaladoc-1.0-SNAPSHOT.jar -Xbootclasspath/a:$REPO/org/scala-lang/scala-library/$SCALA_VERSION/scala-library-$SCALA_VERSION.jar org.scala_tools.vscaladoc.Main -Ydoc -classpath ./target/classes:$REPO/org/scala-lang/scala-library/$SCALA_VERSION/scala-library-$SCALA_VERSION.jar:$REPO/org/scala-lang/scala-vscala$SCALA_VERSION/scala-compiler-$SCALA_VERSION.jar -d ./target/site/scaladocs -sourcepath ./src/main/scala ./src/main/scala/org/scala_tools/vscaladoc/demo/DemoA.scala ./src/main/scala/org/scala_tools/vscaladoc/demo/DemoB.scala

Isn't this script a bit outdated?  I haven't tried it out yet, though.  For example, $SCALA_VERSION shouldn't be needed anymore and "-Ydoc" doesn't work as far as I remember.  Don't you have something more sophisticated or do you mainly support maven?  With ``sophisticated'' I definitely don't want to put any pressure on you, but I am just asking for a more clever shell script, like one figuring out the files to parse by passing a directory on the command line ... stuff like that.  I just think that with such support more people could easily use vscaladoc (just my 2ct).

Cheers,
--
Normen Müller

Thanks for your understanding/ agreement and fast response.
Looks like some is really taking care of vscaladoc ;)

In the first step, as I am not a ``shell-guru'', could you help me out
with a (more or less) sophisticated script?

On Feb 19, 2009, at 9:27 AM, David Bernard wrote:
> * $SCALA_VERSION is used in my script because I add version number
> to every jar (and in this case I use jar from a maven repository)
> * -Ydoc is outdated only for scala 2.7.2+ vscaladoc work with
> 2.7.0+, this trick is managed by the maven plugin (so I forgot it
> everytime)
> * listing every .scala file is inherited from scalac that require
> this (it's hidden by ant and maven), this should be fix in the next
> release of vscaladoc and a ticket was created/accepted for scala-2.8
>
> I agree that a more friendly command line version (and an ant task)
> will be a plus (including the ability to not list every .scala)

Cheers,
--
Normen Müller

He David,

I was just playing around with vscaladoc, but unfortunately the furthest I got was (although F.scala is right at this path):

java.lang.AssertionError: assumption failed: file should be under /Users/nmueller/scaup/trunk/src/scaup/io/F.scala
at scala.Predef$.assume(Predef.scala:102)
at org.scala_tools.vscaladoc.FileHelper.relativePathUnderDir(FileHelper.scala:14)
at org.scala_tools.vscaladoc.SourceHtmlizerOn.scalaToHtml(SourceHtmlizer.scala:40)
at org.scala_tools.vscaladoc.SourceHtmlizerOn.scalaToHtml(SourceHtmlizer.scala:13)
at org.scala_tools.vscaladoc.Page4ClassOrObject.linkToSource(Page4ClassOrObject.scala:92)
at org.scala_tools.vscaladoc.Page4ClassOrObject.body(Page4ClassOrObject.scala:32)
at org.scala_tools.vscaladoc.Page4ClassOrObject.body(Page4ClassOrObject.scala:8)
at org.scala_tools.vscaladoc.HtmlPage$class.html(HtmlPage.scala:110)
at org.scala_tools.vscaladoc.ContentPage.html(HtmlPage.scala:222)
at org.scala_tools.vscaladoc.HtmlPage$class.save(HtmlPage.scala:121)
at org.scala_tools.vscaladoc.ContentPage.save(HtmlPage.scala:222)
at org.scala_tools.vscaladoc.HtmlRenderer$$anonfun$render$1.apply(HtmlRenderer.scala:30)
at org.scala_tools.vscaladoc.HtmlRenderer$$anonfun$render$1.apply(HtmlRenderer.scala:30)
at scala.List.foreach(List.scala:834)
at org.scala_tools.vscaladoc.HtmlRenderer.render(HtmlRenderer.scala:30)
at org.scala_tools.vscaladoc.DocDriver.process(DocDriver.scala:99)
at org.scala_tools.vscaladoc.Main$.process(Main.scala:79)
at org.scala_tools.vscaladoc.Main$.main(Main.scala:93)
at org.scala_tools.vscaladoc.Main.main(Main.scala)

Do you have any suggestions?

Cheers,

I just had a look into "def relativePathUnderDir(file: File, dir: File)" realizing you are using canonical paths. So I changed to using canonical paths, but I am still getting the same error but with the canonical path in the error message :(

Normen Müller wrote:
> He David,
>
> I was just playing around with vscaladoc, but unfortunately the furthest
> I got was (although F.scala is right at this path):
>
> java.lang.AssertionError: assumption failed: file should be under
> /Users/nmueller/scaup/trunk/src/scaup/io/F.scala
> at scala.Predef$.assume(Predef.scala:102)
> at
> org.scala_tools.vscaladoc.FileHelper.relativePathUnderDir(FileHelper.scala:14)
>
> at
> org.scala_tools.vscaladoc.SourceHtmlizerOn.scalaToHtml(SourceHtmlizer.scala:40)
>
> at
> org.scala_tools.vscaladoc.SourceHtmlizerOn.scalaToHtml(SourceHtmlizer.scala:13)
>
> at
> org.scala_tools.vscaladoc.Page4ClassOrObject.linkToSource(Page4ClassOrObject.scala:92)
>
> at
> org.scala_tools.vscaladoc.Page4ClassOrObject.body(Page4ClassOrObject.scala:32)
>
> at
> org.scala_tools.vscaladoc.Page4ClassOrObject.body(Page4ClassOrObject.scala:8)
>
> at org.scala_tools.vscaladoc.HtmlPage$class.html(HtmlPage.scala:110)
> at org.scala_tools.vscaladoc.ContentPage.html(HtmlPage.scala:222)
> at org.scala_tools.vscaladoc.HtmlPage$class.save(HtmlPage.scala:121)
> at org.scala_tools.vscaladoc.ContentPage.save(HtmlPage.scala:222)
> at
> org.scala_tools.vscaladoc.HtmlRenderer$$anonfun$render$1.apply(HtmlRenderer.scala:30)
>
> at
> org.scala_tools.vscaladoc.HtmlRenderer$$anonfun$render$1.apply(HtmlRenderer.scala:30)
>
> at scala.List.foreach(List.scala:834)
> at org.scala_tools.vscaladoc.HtmlRenderer.render(HtmlRenderer.scala:30)
> at org.scala_tools.vscaladoc.DocDriver.process(DocDriver.scala:99)
> at org.scala_tools.vscaladoc.Main$.process(Main.scala:79)
> at org.scala_tools.vscaladoc.Main$.main(Main.scala:93)
> at org.scala_tools.vscaladoc.Main.main(Main.scala)
>
> Do you have any suggestions?
>
> Cheers,

Cheers,

Hi,

Which version of vscaladoc do you used ?
What is the real path of F.scala.

On Fri, Feb 20, 2009 at 01:07, Normen Müller <normen.mueller@googlemail.com> wrote:

I just had a look into "def relativePathUnderDir(file: File, dir: File)" realizing you are using canonical paths.  So I changed to using canonical paths, but I am still getting the same error but with the canonical path in the error message :(

Normen Müller wrote:

He David,

I was just playing around with vscaladoc, but unfortunately the furthest I got was (although F.scala is right at this path):

java.lang.AssertionError: assumption failed: file should be under /Users/nmueller/scaup/trunk/src/scaup/io/F.scala
   at scala.Predef$.assume(Predef.scala:102)
   at org.scala_tools.vscaladoc.FileHelper.relativePathUnderDir(FileHelper.scala:14)
   at org.scala_tools.vscaladoc.SourceHtmlizerOn.scalaToHtml(SourceHtmlizer.scala:40)
   at org.scala_tools.vscaladoc.SourceHtmlizerOn.scalaToHtml(SourceHtmlizer.scala:13)
   at org.scala_tools.vscaladoc.Page4ClassOrObject.linkToSource(Page4ClassOrObject.scala:92)
   at org.scala_tools.vscaladoc.Page4ClassOrObject.body(Page4ClassOrObject.scala:32)
   at org.scala_tools.vscaladoc.Page4ClassOrObject.body(Page4ClassOrObject.scala:8)
   at org.scala_tools.vscaladoc.HtmlPage$class.html(HtmlPage.scala:110)
   at org.scala_tools.vscaladoc.ContentPage.html(HtmlPage.scala:222)
   at org.scala_tools.vscaladoc.HtmlPage$class.save(HtmlPage.scala:121)
   at org.scala_tools.vscaladoc.ContentPage.save(HtmlPage.scala:222)
   at org.scala_tools.vscaladoc.HtmlRenderer$$anonfun$render$1.apply(HtmlRenderer.scala:30)
   at org.scala_tools.vscaladoc.HtmlRenderer$$anonfun$render$1.apply(HtmlRenderer.scala:30)
   at scala.List.foreach(List.scala:834)
   at org.scala_tools.vscaladoc.HtmlRenderer.render(HtmlRenderer.scala:30)
   at org.scala_tools.vscaladoc.DocDriver.process(DocDriver.scala:99)
   at org.scala_tools.vscaladoc.Main$.process(Main.scala:79)
   at org.scala_tools.vscaladoc.Main$.main(Main.scala:93)
   at org.scala_tools.vscaladoc.Main.main(Main.scala)

Do you have any suggestions?

Cheers,

Cheers,

He,

David Bernard wrote:
> Which version of vscaladoc do you used ?

v1.1

> What is the real path of F.scala.

The real path is
/Users/nmueller/vc/svn/scaup/trunk/src/scaup/io/F.scala
compared to
/Users/nmueller/scaup/trunk/src/scaup/io/F.scala

Cheers,

could you try the v1.2-SNAPSHOT (lot of fix) :
http://scala-tools.org/repo-snapshots/org/scala-tools/vscaladoc/1.2-SNAPSHOT/vscaladoc-1.2-SNAPSHOT.jar

On Fri, Feb 20, 2009 at 10:06, Normen Müller <normen.mueller@googlemail.com> wrote:

He,

David Bernard wrote:

Which version of vscaladoc do you used ?

v1.1

What is the real path of F.scala.

The real path is
/Users/nmueller/vc/svn/scaup/trunk/src/scaup/io/F.scala
compared to
/Users/nmueller/scaup/trunk/src/scaup/io/F.scala

Cheers,

On 18 Feb 2009, at 08:28, Normen Müller wrote:

> On Feb 18, 2009, at 2:32 PM, David Bernard wrote:
>> Have you try vscaladoc ?
>> http://code.google.com/p/vscaladoc/
>
> Is it possible to easy use vscaladoc with ant? Cause I am not
> using maven. If it is possible, I'd love to do so and file
> potential bugs.

I have a vscaladoc rule in scala-build (ant files): http://github.com/robey/scala-build/

robey