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

[vscaladoc2] work in progress

2 replies
david.bernard
Joined: 2009-01-08,
User offline. Last seen 1 year 27 weeks ago.

Hi,

A quick note to inform about progression of Vscaladoc2.

Vscaladoc2 is an api documentation tools (suite) :

* vscaladoc2_genjson : extract api from scala source into json files
(store under $HOME/.config/vscaladoc2/apis)
http://github.com/davidB/vscaladoc2_genjson
* vscaladoc2_demoprj : a sample project (with lot of case of
documention, /** ... */ in *.scala, overview.html, package.html,...)
http://github.com/davidB/vscaladoc2_demoprj
* vscaladoc2_www : a webapp use to display api (html, json) and cross
link reference support linking to external apidoc in Scaladoc,
Scaladoc2, Javadoc2
http://github.com/davidB/vscaladoc2_www

You could see first results of vscaladoc2 on-line at
http://vscaladoc.alchim31.net/ (run vscaladoc2_www)

The current version is pretty slow, mainly because the web server
(hosted in U.S.A) doesn't host original data api in json format.
I deployed (as sample) the api in json format on a French server :
http://alchim31.free.fr/apis/

/davidB

David Pollak
Joined: 2008-12-16,
User offline. Last seen 42 years 45 weeks ago.
Re: [vscaladoc2] work in progress
David,

This is very interesting stuff.  What versions of Scala does it work against?

Thanks,

David

On Wed, Nov 3, 2010 at 3:47 PM, David Bernard <david [dot] bernard [dot] 31 [at] gmail [dot] com> wrote:
Hi,

A quick note to inform about progression of Vscaladoc2.

Vscaladoc2 is an api documentation tools (suite) :

* vscaladoc2_genjson : extract api from scala source into json files
(store under $HOME/.config/vscaladoc2/apis)
 http://github.com/davidB/vscaladoc2_genjson
* vscaladoc2_demoprj : a sample project (with lot of case of
documention, /** ... */ in *.scala, overview.html, package.html,...)
 http://github.com/davidB/vscaladoc2_demoprj
* vscaladoc2_www : a webapp use to display api (html, json) and cross
link reference support linking to external apidoc in Scaladoc,
Scaladoc2, Javadoc2
 http://github.com/davidB/vscaladoc2_www

You could see first results of vscaladoc2 on-line at
http://vscaladoc.alchim31.net/ (run vscaladoc2_www)

The current version is pretty slow, mainly because the web server
(hosted in U.S.A) doesn't host original data api in json format.
I deployed (as sample) the api in json format on a French server :
http://alchim31.free.fr/apis/

/davidB



--
Lift, the simply functional web framework http://liftweb.net
Beginning Scala http://www.apress.com/book/view/1430219890
Follow me: http://twitter.com/dpp
Blog: http://goodstuff.im
Surf the harmonics
david.bernard
Joined: 2009-01-08,
User offline. Last seen 1 year 27 weeks ago.
Re: [vscaladoc2] work in progress

Hi,

vscaladoc2_genjson : run for scala 2.8.0, but it use only java lib =>
* could only extract doc for code for scala 2.8.0
* could be upgraded to 2.8.1 "quickly"

vscaladoc2_www : run on lift_2.8.0-2.1, scalate-1.3.1 :
* no constraint about scala version for api (as data are in json)

/davidB

On Thu, Nov 4, 2010 at 05:22, David Pollak
wrote:
> David,
>
> This is very interesting stuff.  What versions of Scala does it work
> against?
>
> Thanks,
>
> David
>
> On Wed, Nov 3, 2010 at 3:47 PM, David Bernard
> wrote:
>>
>> Hi,
>>
>> A quick note to inform about progression of Vscaladoc2.
>>
>> Vscaladoc2 is an api documentation tools (suite) :
>>
>> * vscaladoc2_genjson : extract api from scala source into json files
>> (store under $HOME/.config/vscaladoc2/apis)
>>  http://github.com/davidB/vscaladoc2_genjson
>> * vscaladoc2_demoprj : a sample project (with lot of case of
>> documention, /** ... */ in *.scala, overview.html, package.html,...)
>>  http://github.com/davidB/vscaladoc2_demoprj
>> * vscaladoc2_www : a webapp use to display api (html, json) and cross
>> link reference support linking to external apidoc in Scaladoc,
>> Scaladoc2, Javadoc2
>>  http://github.com/davidB/vscaladoc2_www
>>
>> You could see first results of vscaladoc2 on-line at
>> http://vscaladoc.alchim31.net/ (run vscaladoc2_www)
>>
>> The current version is pretty slow, mainly because the web server
>> (hosted in U.S.A) doesn't host original data api in json format.
>> I deployed (as sample) the api in json format on a French server :
>> http://alchim31.free.fr/apis/
>>
>> /davidB
>
>
>
> --
> Lift, the simply functional web framework http://liftweb.net
> Beginning Scala http://www.apress.com/book/view/1430219890
> Follow me: http://twitter.com/dpp
> Blog: http://goodstuff.im
> Surf the harmonics
>

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