VScaladoc2beta


VScaladoc2 is the second generation. Second because it no longer generates static html files.

Main advantage : Html rendering could be enhanced, in lot of case, without requiring regeneration of scaladoc by lib's creators.

VScaladoc2 website provide :
  • A central place where API of libraries can be referenced and find (Javadoc2/Scaladoc/Scaladoc2/VScaladoc2)
    for every format except vscaladoc2, request are redirected
  • A html displayer for API generated in JSON format via vscaladoc2_genjson
  • ...
QoS info
VScaladoc2 website provide :
  • A central place where API of libraries can be referenced and find (Javadoc2/Scaladoc/Scaladoc2/VScaladoc2)
    for every format except vscaladoc2, request are redirected
  • A html displayer for API generated in JSON format via vscaladoc2_genjson
  • Support documentation in overview.html, package.html
  • Support multi-artifacts project and cross artifact reference
  • Support custom doctag
    by default every doctags are displays, but some could have special display (eg : deprecated, tags (wip)). So today, you could use doctags you like, generate doc / release and have better display tomorrow.
    @tags use a space separeted list of keyword
  • provide a primitive discussion system (google-groups as back-end)
    • no messages stored by vscaladoc => no risk to drop messages if vscaladoc fails
    • no registration to vscaladoc2 required
    • lib's owners manage/moderate as they wish
    • native email integration/notification => more reactivity
    • other back-end are possible (nabble,...) request it
  • it is in staging, so reporting bugs, suggestions,... are all welcome
  • every 24H the server hibernate (rule for [host](http://stax.net)), some features/renderer could take time to restart (lazy)
  • it can be updated/restarted several times by week
  • it doesn't host your data (api, comment), it only cache or redirect

Apis

jse 1.6(Javadoc2)
lift_2.8.1 2.3-M1(VScaladoc2) 2.2-RC1(VScaladoc2) 2.2(VScaladoc2)
sbt 0.7.4(Scaladoc)
scala-library 2.8.1(VScaladoc2) 2.8.0(VScaladoc2) 2.7.7(Scaladoc)
scalatest 1.2(Scaladoc2)
vscaladoc2_demoprj 0.1-SNAPSHOT(VScaladoc2)

Powered by Lift