vscaladoc - Project Hosting on Google Code

Last 30 days Nov 28, 2009 issue 32 (Provide Ant Task wrapper) reported by opencoeli - I dont use Maven. Shell script is very hard to use. Please provide wrapper for ant. So it can be invoked as normal Ant task. I dont use Maven. Shell script is very hard to use. Please provide wrapper for ant. So it can be invoked as normal Ant task. Earlier this year Oct 11, 2009 issue 29 (mvn site fails with IOException) commented on by anth...@whitford.com - So since 1.2-SNAPSHOT works, yet 1.1 does not... When will a 1.2 release be available? So since 1.2-SNAPSHOT works, yet 1.1 does not... When will a 1.2 release be available? Oct 11, 2009 issue 29 (mvn site fails with IOException) commented on by anth...@whitford.com - I tried this using Scala 2.7.5 and the latest Maven Scala Plugin (2.12.2), and it looks like this is resolved with the 1.2-SNAPSHOT of vscaladoc. Note that trying to use 1.1 results in a NullPointerException: java.lang.NullPointerException at scala.runtime.RichString.split(RichString.scala:195) at org.scala_tools.vscaladoc.LinkHelper.relativize(LinkHelper.scala:37) at org.scala_tools.vscaladoc.HtmlPage$class.relativize(HtmlPage.scala:25) at org.scala_tools.vscaladoc.ContentPage.relativize(HtmlPage.scala:222) at org.scala_tools.vscaladoc.Page4ClassOrObject$$anonfun$linkToSource$2.apply(Page4Class OrObject.scala:94) at org.scala_tools.vscaladoc.Page4ClassOrObject$$anonfun$linkToSource$2.apply(Page4Class OrObject.scala:94) at scala.Option.map(Option.scala:70) at org.scala_tools.vscaladoc.Page4ClassOrObject.linkToSource(Page4ClassOrObject.scala:94 ) 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:841) 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) At this point I am unsure if the latest snapshot of vscaladoc fixed this, or the latest maven scala plugin resolved the issue, but I think it is safe to close this issue. I tried this using Scala 2.7.5 and the latest Maven Scala Plugin (2.12.2), and it looks like this is resolved with the 1.2-SNAPSHOT of vscaladoc. Note that trying to use 1.1 results in a NullPointerException: java.lang.NullPointerException at scala.runtime.RichString.split(RichString.scala:195) at org.scala_tools.vscaladoc.LinkHelper.relativize(LinkHelper.scala:37) at org.scala_tools.vscaladoc.HtmlPage$class.relativize(HtmlPage.scala:25) at org.scala_tools.vscaladoc.ContentPage.relativize(HtmlPage.scala:222) at org.scala_tools.vscaladoc.Page4ClassOrObject$$anonfun$linkToSource$2.apply(Page4Class OrObject.scala:94) at org.scala_tools.vscaladoc.Page4ClassOrObject$$anonfun$linkToSource$2.apply(Page4Class OrObject.scala:94) at scala.Option.map(Option.scala:70) at org.scala_tools.vscaladoc.Page4ClassOrObject.linkToSource(Page4ClassOrObject.scala:94 ) 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:841) 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) At this point I am unsure if the latest snapshot of vscaladoc fixed this, or the latest maven scala plugin resolved the issue, but I think it is safe to close this issue. Jun 20, 2009 issue 31 (Package summary page?) Status changed by david.bernard.31 - It's not planned. As I reply on the mailing list the workflow in vscaladoc is different : package description are merged in overview. But as you considere this features usefull. I add it in the TODO list (don't know when I'll time to implement it, patch are welcome) Status: Accepted It's not planned. As I reply on the mailing list the workflow in vscaladoc is different : package description are merged in overview. But as you considere this features usefull. I add it in the TODO list (don't know when I'll time to implement it, patch are welcome) Status: Accepted Jun 17, 2009 issue 31 (Package summary page?) reported by davetron5000 - With scaladoc and javadoc, when you select a package, the main frame shows you the list of classes and their one-line description. This is a huge usability benefit to javadoc/scaladoc, especially when learning or searching for existing code. I haven't seen any vscaladoc implement this. Is this planned (or how can I bring this up?) With scaladoc and javadoc, when you select a package, the main frame shows you the list of classes and their one-line description. This is a huge usability benefit to javadoc/scaladoc, especially when learning or searching for existing code. I haven't seen any vscaladoc implement this. Is this planned (or how can I bring this up?) Jun 03, 2009 issue 29 (mvn site fails with IOException) commented on by anth...@whitford.com - This problem remains. However, there seems to be a problem with the maven-scala- plugin version 2.11-SNAPSHOT today, so you may need to revert that to 2.10.1 to successfully compile the test code. The exception at org.scala_tools.vscaladoc.FileHelper.forceDelete (FileHelper.scala:211) remains an open issue. This problem remains. However, there seems to be a problem with the maven-scala- plugin version 2.11-SNAPSHOT today, so you may need to revert that to 2.10.1 to successfully compile the test code. The exception at org.scala_tools.vscaladoc.FileHelper.forceDelete (FileHelper.scala:211) remains an open issue. Apr 05, 2009 issue 30 (Logging appears as Warnings instead of Information) reported by anth...@whitford.com - Run: mvn scala:doc I see output like: [INFO] [scala:doc] [INFO] Checking for multiple versions of scala [INFO] Checking for multiple versions of scala [WARNING] Apr 5, 2009 10:23:36 PM org.scala_tools.vscaladoc.HtmlRenderer render [WARNING] INFO: write page for overview [WARNING] Apr 5, 2009 10:23:36 PM org.scala_tools.vscaladoc.HtmlRenderer render [WARNING] INFO: write page for all-classes (list) [WARNING] Apr 5, 2009 10:23:36 PM org.scala_tools.vscaladoc.HtmlRenderer render [WARNING] INFO: write index.html [WARNING] Apr 5, 2009 10:23:36 PM org.scala_tools.vscaladoc.HtmlRenderer render [WARNING] INFO: write doc for each classes The messages that are generated by vscaladoc are informational (INFO), but maven is logging them as WARNING messages. It would be great to see this fixed. I am using Windows Vista 32-bit, Java 1.6.0_12, Maven 2.0.9, and the latest snapshot build of vscaladoc, and the latest snapshot build of the maven-scala-plugin. (Note that there is a sample project attached to Issue 29 that can illustrate this issue.) Run: mvn scala:doc I see output like: [INFO] [scala:doc] [INFO] Checking for multiple versions of scala [INFO] Checking for multiple versions of scala [WARNING] Apr 5, 2009 10:23:36 PM org.scala_tools.vscaladoc.HtmlRenderer render [WARNING] INFO: write page for overview [WARNING] Apr 5, 2009 10:23:36 PM org.scala_tools.vscaladoc.HtmlRenderer render [WARNING] INFO: write page for all-classes (list) [WARNING] Apr 5, 2009 10:23:36 PM org.scala_tools.vscaladoc.HtmlRenderer render [WARNING] INFO: write index.html [WARNING] Apr 5, 2009 10:23:36 PM org.scala_tools.vscaladoc.HtmlRenderer render [WARNING] INFO: write doc for each classes The messages that are generated by vscaladoc are informational (INFO), but maven is logging them as WARNING messages. It would be great to see this fixed. I am using Windows Vista 32-bit, Java 1.6.0_12, Maven 2.0.9, and the latest snapshot build of vscaladoc, and the latest snapshot build of the maven-scala-plugin. (Note that there is a sample project attached to Issue 29 that can illustrate this issue.) Apr 05, 2009 issue 29 (mvn site fails with IOException) reported by anth...@whitford.com - To reproduce the problem: 1. I have a sample project that was generated using the scala archetype. 2. Using git, I downloaded the latest source code for vscaladoc (and built it: mvn install) because I noticed that the line numbers weren't aligning to the online source code -- so now my stack trace is pretty clear. 3. mvn site fails with the stack trace: [INFO] Generating "ScalaDocs" report. [INFO] Checking for multiple versions of scala [WARNING] Exception in thread "main" java.io.IOException: Unable to delete file: C:\workspaces\scala\myfirst\target\site\scaladocs\index.html [WARNING] at org.scala_tools.vscaladoc.FileHelper.forceDelete(FileHelper.scala:211) [WARNING] at org.scala_tools.vscaladoc.FileHelper$$anonfun$cleanDirectory$1.apply(FileHelper.scala:178) [WARNING] at org.scala_tools.vscaladoc.FileHelper$$anonfun$cleanDirectory$1.apply(FileHelper.scala:176) [WARNING] at scala.Iterator$class.foreach(Iterator.scala:414) [WARNING] at scala.runtime.BoxedArray$AnyIterator.foreach(BoxedArray.scala:45) [WARNING] at scala.Iterable$class.foreach(Iterable.scala:256) [WARNING] at scala.runtime.BoxedArray.foreach(BoxedArray.scala:24) [WARNING] at org.scala_tools.vscaladoc.FileHelper.cleanDirectory(FileHelper.scala:176) [WARNING] at org.scala_tools.vscaladoc.FileHelper.deleteDirectory(FileHelper.scala:114) [WARNING] at org.scala_tools.vscaladoc.DocDriver.init(DocDriver.scala:32) [WARNING] at org.scala_tools.vscaladoc.Main$.process(Main.scala:89) [WARNING] at org.scala_tools.vscaladoc.Main$.main(Main.scala:107) [WARNING] at org.scala_tools.vscaladoc.Main.main(Main.scala) Obviously, I would expect the site to complete successfully. I am using Windows Vista, JDK 1.6.0_12, Maven 2.0.9, vscaladoc-1.2-SNAPSHOT, and even 2.11-SNAPSHOT of the maven-scala-plugin. (Note that I experienced the problem with other versions, but tried a final time with the latest snapshots to confirm that the problem is not yet resolved before logging an issue.) It is possible that this problem is limited to Windows since its file locking behavior differs from NIX. Note that mvn scala:doc does complete successfully. One weird thing is that the results end up in target\site\scaladocs\scaladocs (instead of target\site\scaladocs). To reproduce the problem: 1. I have a sample project that was generated using the scala archetype. 2. Using git, I downloaded the latest source code for vscaladoc (and built it: mvn install) because I noticed that the line numbers weren't aligning to the online source code -- so now my stack trace is pretty clear. 3. mvn site fails with the stack trace: [INFO] Generating "ScalaDocs" report. [INFO] Checking for multiple versions of scala [WARNING] Exception in thread "main" java.io.IOException: Unable to delete file: C:\workspaces\scala\myfirst\target\site\scaladocs\index.html [WARNING] at org.scala_tools.vscaladoc.FileHelper.forceDelete(FileHelper.scala:211) [WARNING] at org.scala_tools.vscaladoc.FileHelper$$anonfun$cleanDirectory$1.apply(FileHelper.scala:178) [WARNING] at org.scala_tools.vscaladoc.FileHelper$$anonfun$cleanDirectory$1.apply(FileHelper.scala:176) [WARNING] at scala.Iterator$class.foreach(Iterator.scala:414) [WARNING] at scala.runtime.BoxedArray$AnyIterator.foreach(BoxedArray.scala:45) [WARNING] at scala.Iterable$class.foreach(Iterable.scala:256) [WARNING] at scala.runtime.BoxedArray.foreach(BoxedArray.scala:24) [WARNING] at org.scala_tools.vscaladoc.FileHelper.cleanDirectory(FileHelper.scala:176) [WARNING] at org.scala_tools.vscaladoc.FileHelper.deleteDirectory(FileHelper.scala:114) [WARNING] at org.scala_tools.vscaladoc.DocDriver.init(DocDriver.scala:32) [WARNING] at org.scala_tools.vscaladoc.Main$.process(Main.scala:89) [WARNING] at org.scala_tools.vscaladoc.Main$.main(Main.scala:107) [WARNING] at org.scala_tools.vscaladoc.Main.main(Main.scala) Obviously, I would expect the site to complete successfully. I am using Windows Vista, JDK 1.6.0_12, Maven 2.0.9, vscaladoc-1.2-SNAPSHOT, and even 2.11-SNAPSHOT of the maven-scala-plugin. (Note that I experienced the problem with other versions, but tried a final time with the latest snapshots to confirm that the problem is not yet resolved before logging an issue.) It is possible that this problem is limited to Windows since its file locking behavior differs from NIX. Note that mvn scala:doc does complete successfully. One weird thing is that the results end up in target\site\scaladocs\scaladocs (instead of target\site\scaladocs). Feb 20, 2009 issue 28 (package description of packages without any sources is negle...) reported by normen.mueller - A "package.html" file in a package which does not have any source files but sub-packages do is ignored. For example: org/foo/package.html org/foo/bar/a.scala org/foo/bar/b.scala A "package.html" file in a package which does not have any source files but sub-packages do is ignored. For example: org/foo/package.html org/foo/bar/a.scala org/foo/bar/b.scala Feb 18, 2009 issue 27 (provide an anttask or an easy way to call vscaldoc from ant) reported by david.bernard.31 - see summary see summary Feb 05, 2009 issue 24 (patch: allow use of markdown instead of html) commented on by robeysf - oh hey, awesome! i actually added textile support too, because one of my coworkers really likes that. :) oh hey, awesome! i actually added textile support too, because one of my coworkers really likes that. :) Jan 31, 2009 issue 24 (patch: allow use of markdown instead of html) Status changed by david.bernard.31 - Thanks for the contributions. Nice feature, I planned to add a similar feature but a subset of textile and markdown and using xml tag for fragment/macro like code sample... I'm intersting by the patch, and why you can't compile the project with maven (except that you don't have luck with it). I recently move the source to github (http://github.com/davidB/vscaladoc/tree/master) Next week(end), I'll take a look to your fork, I would like to release a new version for ~ 2009/02/18 Status: Accepted Thanks for the contributions. Nice feature, I planned to add a similar feature but a subset of textile and markdown and using xml tag for fragment/macro like code sample... I'm intersting by the patch, and why you can't compile the project with maven (except that you don't have luck with it). I recently move the source to github (http://github.com/davidB/vscaladoc/tree/master) Next week(end), I'll take a look to your fork, I would like to release a new version for ~ 2009/02/18 Status: Accepted Jan 29, 2009 issue 25 (java.io.FileNotFoundException) Status changed by david.bernard.31 - Status: Fixed Status: Fixed Jan 29, 2009 issue 25 (java.io.FileNotFoundException) commented on by harshad.rj - The wip version worked like a charm. In fact, it solved another problem (not related to this bug) which I was facing in another project. Thanks! I run vscaladoc on a command line like this: scala -cp ~/Download/vscaladoc-1.2-SNAPSHOT.jar org.scala_tools.vscaladoc.Main src/main/scala/* -dtarget/vdoc/ The wip version worked like a charm. In fact, it solved another problem (not related to this bug) which I was facing in another project. Thanks! I run vscaladoc on a command line like this: scala -cp ~/Download/vscaladoc-1.2-SNAPSHOT.jar org.scala_tools.vscaladoc.Main src/main/scala/* -dtarget/vdoc/ Jan 29, 2009 issue 25 (java.io.FileNotFoundException) Status changed by david.bernard.31 - Hi, thanks for reporting the issues. * How do you run vscaladoc (throught a command line/shell script(could you provide it) or maven ? * could you try the wip version http://scala-tools.org/repo-snapshots/org/scala-tools/vscaladoc/1.2-SNAPSHOT/vscaladoc-1.2-SNAPSHOT.jar Status: Accepted Hi, thanks for reporting the issues. * How do you run vscaladoc (throught a command line/shell script(could you provide it) or maven ? * could you try the wip version http://scala-tools.org/repo-snapshots/org/scala-tools/vscaladoc/1.2-SNAPSHOT/vscaladoc-1.2-SNAPSHOT.jar Status: Accepted Jan 28, 2009 issue 25 (java.io.FileNotFoundException) reported by harshad.rj - This is the first time I am using vscaladoc. I tried it on two projects and I got this exception in both of them. java.io.FileNotFoundException: target/vdoc/src/main/scala/managed.scala.html (No such file or directory) at java.io.FileOutputStream.open(Native Method) at java.io.FileOutputStream.<init>(FileOutputStream.java:209) at java.io.FileOutputStream.<init>(FileOutputStream.java:160) at org.scala_tools.vscaladoc.FileHelper.writeTextToFile(FileHelper.scala:76) at org.scala_tools.vscaladoc.SourceHtmlizerOn.scalaToHtml(SourceHtmlizer.scala:45) 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) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) at java.lang.reflect.Method.invoke(Method.java:616) at scala.tools.nsc.ObjectRunner$$anonfun$run$1.apply(ObjectRunner.scala:75) at scala.tools.nsc.ObjectRunner$.withContextClassLoader(ObjectRunner.scala:49) at scala.tools.nsc.ObjectRunner$.run(ObjectRunner.scala:74) at scala.tools.nsc.MainGenericRunner$.main(MainGenericRunner.scala:164) at scala.tools.nsc.MainGenericRunner.main(MainGenericRunner.scala) What steps will reproduce the problem? 1. Checkout code from http://code.google.com/p/jamun/ 2. Get dependencies for project: Woodstox, derby and http://scala-utilities.googlecode.com/files/scala_utils_2.jar 3. Run vscaladoc on src/main/scala/* What is the expected output? What do you see instead? Only part of the documentation is generated (frames, etc). Actual documentation is missing. What version of the product are you using? On what operating system? vscaladoc 1.1 scala 2.7.2 on Fedora 10 Please provide any additional information below. Do let me know if you need any other information to debug. This is the first time I am using vscaladoc. I tried it on two projects and I got this exception in both of them. java.io.FileNotFoundException: target/vdoc/src/main/scala/managed.scala.html (No such file or directory) at java.io.FileOutputStream.open(Native Method) at java.io.FileOutputStream.<init>(FileOutputStream.java:209) at java.io.FileOutputStream.<init>(FileOutputStream.java:160) at org.scala_tools.vscaladoc.FileHelper.writeTextToFile(FileHelper.scala:76) at org.scala_tools.vscaladoc.SourceHtmlizerOn.scalaToHtml(SourceHtmlizer.scala:45) 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) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) at java.lang.reflect.Method.invoke(Method.java:616) at scala.tools.nsc.ObjectRunner$$anonfun$run$1.apply(ObjectRunner.scala:75) at scala.tools.nsc.ObjectRunner$.withContextClassLoader(ObjectRunner.scala:49) at scala.tools.nsc.ObjectRunner$.run(ObjectRunner.scala:74) at scala.tools.nsc.MainGenericRunner$.main(MainGenericRunner.scala:164) at scala.tools.nsc.MainGenericRunner.main(MainGenericRunner.scala) What steps will reproduce the problem? 1. Checkout code from http://code.google.com/p/jamun/ 2. Get dependencies for project: Woodstox, derby and http://scala-utilities.googlecode.com/files/scala_utils_2.jar 3. Run vscaladoc on src/main/scala/* What is the expected output? What do you see instead? Only part of the documentation is generated (frames, etc). Actual documentation is missing. What version of the product are you using? On what operating system? vscaladoc 1.1 scala 2.7.2 on Fedora 10 Please provide any additional information below. Do let me know if you need any other information to debug. Older Dec 22, 2008 issue 24 (patch: allow use of markdown instead of html) reported by robeysf - This is a patch, not a bug, but the wiki asks me to post patches here. I couldn't get the maven build to work on svn revision 25, so I pulled the project into github and added an ant file so I could build it. I then added support for a new "-format-markdown" command-line option, which causes the scaladoc "body" strings to be sent into markdownj before pasting into the output HTML. This lets people write scaladoc in a more-readable format than HTML while it's in the code. The idea seemed to go over well at the last SF BASE meeting so I thought I'd implement it and post it for you. The github branch is here: http://github.com/robey/vscaladoc/tree/master This is a patch, not a bug, but the wiki asks me to post patches here. I couldn't get the maven build to work on svn revision 25, so I pulled the project into github and added an ant file so I could build it. I then added support for a new "-format-markdown" command-line option, which causes the scaladoc "body" strings to be sent into markdownj before pasting into the output HTML. This lets people write scaladoc in a more-readable format than HTML while it's in the code. The idea seemed to go over well at the last SF BASE meeting so I thought I'd implement it and post it for you. The github branch is here: http://github.com/robey/vscaladoc/tree/master Dec 18, 2008 issue 22 (vscaladoc does not generate docs for scala.Any, scala.AnyRef...) changed by david.bernard.31 - Thanks for the patch, I'll review/apply it ASAP Status: Accepted Labels: Type-Patch Thanks for the patch, I'll review/apply it ASAP Status: Accepted Labels: Type-Patch Dec 17, 2008 issue 22 (vscaladoc does not generate docs for scala.Any, scala.AnyRef...) commented on by atsuhiko.yamanaka - Please allow me to update the submitted patch with attached one. Please allow me to update the submitted patch with attached one. Dec 17, 2008 issue 23 (Slightly-Incorrect Placement of Class/Trait/Object Selectors) reported by djspiewak - It seems that the Class, Trait and Object selectors are positioned incorrectly in the left frame. On some platforms, this causes them to be rendered slightly-behind the search box. This doesn't affect functionality, but it is quite ugly. Please see the attached screenshot. It seems that the Class, Trait and Object selectors are positioned incorrectly in the left frame. On some platforms, this causes them to be rendered slightly-behind the search box. This doesn't affect functionality, but it is quite ugly. Please see the attached screenshot. Dec 17, 2008 issue 22 (vscaladoc does not generate docs for scala.Any, scala.AnyRef...) reported by atsuhiko.yamanaka - What steps will reproduce the problem? 1. Even if the source code of the scala package is given, scala.Any, scala.AnyRef, etc. will not be generated, because there do not exist source code for those classes. What is the expected output? What do you see instead? The scaladoc command(or scaladoc ant task) can generate them. So, it must be nice if vscaladoc can do also. What version of the product are you using? On what operating system? vscaladoc svn trunk HEAD, scala 2.7.2.final and GNU/Linux(Fedora) Please provide any additional information below. I'll attach a patch file to generate docs for those classes. That is a diff for the svn trunk HEAD. What steps will reproduce the problem? 1. Even if the source code of the scala package is given, scala.Any, scala.AnyRef, etc. will not be generated, because there do not exist source code for those classes. What is the expected output? What do you see instead? The scaladoc command(or scaladoc ant task) can generate them. So, it must be nice if vscaladoc can do also. What version of the product are you using? On what operating system? vscaladoc svn trunk HEAD, scala 2.7.2.final and GNU/Linux(Fedora) Please provide any additional information below. I'll attach a patch file to generate docs for those classes. That is a diff for the svn trunk HEAD. Dec 02, 2008 issue 21 (RFE: Special iPhone/Android Skin) commented on by djspiewak - I would imagine the UI as something more multi-pane to avoid the frames issue. Thus, there would be a search pane which also showed results. Filtering could be either in that frame, or more likely (for space reasons) in a separate pane. The documentation itself could be viewed in a separate pane entirely. The important limitation is that AJAX as-you-type search doesn't work too well on underpowered devices. The iPhone particularly takes a lot of horsepower typing (due to the visual effects and auto-complete). It becomes almost unusable when there are javascript actions triggered by text entry. Even StackOverflow's "characters left" counter is too much. Aptana includes an iPhone simulator (it even spoofs the user agent IIRC). There are also a number of iPhone simultator sites that help with sizing and such. With regards to the server side, I wouldn't mind having to click on a separate link to get the iPhone version. Obviously a Javascript redirect based on user-agent would be better, but I think it's more important to just get something usable. No frames at least lets me look at the package list, but clicking on a package does no good. I would imagine the UI as something more multi-pane to avoid the frames issue. Thus, there would be a search pane which also showed results. Filtering could be either in that frame, or more likely (for space reasons) in a separate pane. The documentation itself could be viewed in a separate pane entirely. The important limitation is that AJAX as-you-type search doesn't work too well on underpowered devices. The iPhone particularly takes a lot of horsepower typing (due to the visual effects and auto-complete). It becomes almost unusable when there are javascript actions triggered by text entry. Even StackOverflow's "characters left" counter is too much. Aptana includes an iPhone simulator (it even spoofs the user agent IIRC). There are also a number of iPhone simultator sites that help with sizing and such. With regards to the server side, I wouldn't mind having to click on a separate link to get the iPhone version. Obviously a Javascript redirect based on user-agent would be better, but I think it's more important to just get something usable. No frames at least lets me look at the package list, but clicking on a package does no good. Dec 02, 2008 issue 21 (RFE: Special iPhone/Android Skin) changed by david.bernard.31 - Hi, I don't have mobile nor iPhone, so: * I don't know their limitations. * I can't test solution But I'm ok to include any contributions to support iPhone & Co How do you imagine the integration of the left bar without frames ? Could you use the "no frames" view ? (note : vscaladoc run without server side) Status: Accepted Owner: david.bernard.31 Hi, I don't have mobile nor iPhone, so: * I don't know their limitations. * I can't test solution But I'm ok to include any contributions to support iPhone & Co How do you imagine the integration of the left bar without frames ? Could you use the "no frames" view ? (note : vscaladoc run without server side) Status: Accepted Owner: david.bernard.31 Dec 01, 2008 issue 21 (RFE: Special iPhone/Android Skin) reported by djspiewak - vscaladoc is excellent on full-power clients like the ever-popular personal compute. However, mobile devices such as the iPhone and Android have a much harder time of it. The AJAX search is far too resource intensive even for the iPhone, usually causing Mobile Safari to crash. Furthermore, frames don't work at all in a gesture-based browser. It would be extremely nice if vscaladoc had a mobile (but specifically iPhone) version which was activated based on user agent. This would not only make vscaladoc usable under the iPhone, but would also represent the only viable method for viewing scaladoc on mobile devices. vscaladoc is excellent on full-power clients like the ever-popular personal compute. However, mobile devices such as the iPhone and Android have a much harder time of it. The AJAX search is far too resource intensive even for the iPhone, usually causing Mobile Safari to crash. Furthermore, frames don't work at all in a gesture-based browser. It would be extremely nice if vscaladoc had a mobile (but specifically iPhone) version which was activated based on user agent. This would not only make vscaladoc usable under the iPhone, but would also represent the only viable method for viewing scaladoc on mobile devices. Jul 26, 2008 issue 15 (create list page for some tags (eg: @todo, @experimental, .....) Labels changed by david.bernard.31 - change to low, because complementary tools like IDE and Hudson provide this feature. Labels: Priority-Low −Priority-Medium change to low, because complementary tools like IDE and Hudson provide this feature. Labels: Priority-Low −Priority-Medium Jul 26, 2008 issue 20 (vscaladoc fails generating documentation for classes with th...) changed by david.bernard.31 - Thanks for reporting the bug. I change the priority to low because IMO using default (empty) package is only for very small, or test app that do not really need to provide scaladoc. and there is other feature/bug/tasks more important (IMO). I change the status to "accepted" because, it's a real bug (that need to be fixed) but require some hack to manage this special case (including changing the way package are displayed and selected in the left bar,...) So if you attach a patch I'll check it and apply it if ok. Thanks for your feedback. Status: Accepted Labels: Priority-Low −Priority-Medium Thanks for reporting the bug. I change the priority to low because IMO using default (empty) package is only for very small, or test app that do not really need to provide scaladoc. and there is other feature/bug/tasks more important (IMO). I change the status to "accepted" because, it's a real bug (that need to be fixed) but require some hack to manage this special case (including changing the way package are displayed and selected in the left bar,...) So if you attach a patch I'll check it and apply it if ok. Thanks for your feedback. Status: Accepted Labels: Priority-Low −Priority-Medium Jul 25, 2008 issue 20 (vscaladoc fails generating documentation for classes with th...) reported by sufrin.bernard - What steps will reproduce the problem? 1. vscaladoc on files that include a ''top level'' file defining a package 2. vscaladoc on files that define meterial from the empty package 3. What is the expected output? What do you see instead? Expected output is documentation for the whole collection of files vscaladoc throws an exception (from LinkHelper.uriFor) at // below: if ((!pkg.isEmpty) && (pkg.get != sym)) { val pname = pkg.get.fullNameString('.') val after = pname.length + 1 fileName = fileName.substring(after) // pkgPath = pkgPath + pkg.get.fullNameString('/') } What version of the product are you using? On what operating system? 1.2-SNAPSHOT as built (here) from the repository Mac OS X Please provide any additional information below. No other failures on a really HUGE body of code. Actually I really like the style of documentation you generate! What steps will reproduce the problem? 1. vscaladoc on files that include a ''top level'' file defining a package 2. vscaladoc on files that define meterial from the empty package 3. What is the expected output? What do you see instead? Expected output is documentation for the whole collection of files vscaladoc throws an exception (from LinkHelper.uriFor) at // below: if ((!pkg.isEmpty) && (pkg.get != sym)) { val pname = pkg.get.fullNameString('.') val after = pname.length + 1 fileName = fileName.substring(after) // pkgPath = pkgPath + pkg.get.fullNameString('/') } What version of the product are you using? On what operating system? 1.2-SNAPSHOT as built (here) from the repository Mac OS X Please provide any additional information below. No other failures on a really HUGE body of code. Actually I really like the style of documentation you generate!

issue 25 (java.io.FileNotFoundException) reported by harshad.rj - This is the first time I am using vscaladoc. I tried it on two projects and I got this exception in both of them. java.io.FileNotFoundException: target/vdoc/src/main/scala/managed.scala.html (No such file or directory) at java.io.FileOutputStream.open(Native Method) at java.io.FileOutputStream.<init>(FileOutputStream.java:209) at java.io.FileOutputStream.<init>(FileOutputStream.java:160) at org.scala_tools.vscaladoc.FileHelper.writeTextToFile(FileHelper.scala:76) at org.scala_tools.vscaladoc.SourceHtmlizerOn.scalaToHtml(SourceHtmlizer.scala:45) 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) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) at java.lang.reflect.Method.invoke(Method.java:616) at scala.tools.nsc.ObjectRunner$$anonfun$run$1.apply(ObjectRunner.scala:75) at scala.tools.nsc.ObjectRunner$.withContextClassLoader(ObjectRunner.scala:49) at scala.tools.nsc.ObjectRunner$.run(ObjectRunner.scala:74) at scala.tools.nsc.MainGenericRunner$.main(MainGenericRunner.scala:164) at scala.tools.nsc.MainGenericRunner.main(MainGenericRunner.scala) What steps will reproduce the problem? 1. Checkout code from http://code.google.com/p/jamun/ 2. Get dependencies for project: Woodstox, derby and http://scala-utilities.googlecode.com/files/scala_utils_2.jar 3. Run vscaladoc on src/main/scala/* What is the expected output? What do you see instead? Only part of the documentation is generated (frames, etc). Actual documentation is missing. What version of the product are you using? On what operating system? vscaladoc 1.1 scala 2.7.2 on Fedora 10 Please provide any additional information below. Do let me know if you need any other information to debug.

This is the first time I am using vscaladoc. I tried it on two projects and I got this exception in both of them. java.io.FileNotFoundException: target/vdoc/src/main/scala/managed.scala.html (No such file or directory) at java.io.FileOutputStream.open(Native Method) at java.io.FileOutputStream.<init>(FileOutputStream.java:209) at java.io.FileOutputStream.<init>(FileOutputStream.java:160) at org.scala_tools.vscaladoc.FileHelper.writeTextToFile(FileHelper.scala:76) at org.scala_tools.vscaladoc.SourceHtmlizerOn.scalaToHtml(SourceHtmlizer.scala:45) 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) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) at java.lang.reflect.Method.invoke(Method.java:616) at scala.tools.nsc.ObjectRunner$$anonfun$run$1.apply(ObjectRunner.scala:75) at scala.tools.nsc.ObjectRunner$.withContextClassLoader(ObjectRunner.scala:49) at scala.tools.nsc.ObjectRunner$.run(ObjectRunner.scala:74) at scala.tools.nsc.MainGenericRunner$.main(MainGenericRunner.scala:164) at scala.tools.nsc.MainGenericRunner.main(MainGenericRunner.scala) What steps will reproduce the problem? 1. Checkout code from http://code.google.com/p/jamun/ 2. Get dependencies for project: Woodstox, derby and http://scala-utilities.googlecode.com/files/scala_utils_2.jar 3. Run vscaladoc on src/main/scala/* What is the expected output? What do you see instead? Only part of the documentation is generated (frames, etc). Actual documentation is missing. What version of the product are you using? On what operating system? vscaladoc 1.1 scala 2.7.2 on Fedora 10 Please provide any additional information below. Do let me know if you need any other information to debug.

Last 30 days

Earlier this year

Older