vscaladoc broken?

[Timothy Perrett]

Guys,

Since IRC did the refactor on the vscaladoc package link defs, it
appears that you can no longer click through classes that are not in
that package. For example, clicking through to Box from any package
other than lift-common does nothing.... from a usability perspective,
I think this could be problematic for newbies as thats how a lot of
people learn by hoping through class to class... if its fundamentally
broken, we have a problem.

IRC, can you fix this please?

Cheers, Tim

[Indrajit Raychaudhuri]

Tim,

The scala-tools maven site honors the package link defs.

Did you do scaladoc generation as part site build or as part of
scala:doc?
I am assuming you did the later. And quite likely the configuration
for the jvmArgs (-DpackageLinkDefs in particular) isn't getting
propagated from report plugin to build plugin. Please confirm if this
is the case.

Either way, please raise a ticket. I'll take a look tomorrow or day
after.

Cheers, Indrajit

[Timothy Perrett]

Hey :-)

Yeah I did a mvn scala:doc - what should one run instead? mvn site?

Cheers, Tim

> --
>
> You received this message because you are subscribed to the Google Groups "Lift" group.
> To post to this group, send email to lif...@googlegroups.com.
> To unsubscribe from this group, send email to liftweb+u...@googlegroups.com.
> For more options, visit this group at http://groups.google.com/group/liftweb?hl=en.
>
>
>

[Indrajit Raychaudhuri]

Short answer:
Use "mvn site" for a couple of days to have the package link defs work,
but ideally "mvn scala:doc" should be consistent. I'll fix that, give me
a day or two please.

Long answer:
"mvn site" picks up plugin settings from reporting section and "mvn
scala:doc" picks up plugin settings from build section. The trick
(jvmArg -DpackageLinkDefs) is done in the maven-scala-plugin
configuration in the reporting section. Per Maven's documentation build
plugin settings (and thus config) should be picked up from their
corresponding settings in reporting section (odd, but true). Strangely,
that's happening for all the config elements except for <jvmArgs/>.
So I'll go ahead and duplicate <jvmArgs/> section in both places:report
plugin and build plugin.

Pain:
Next up, you, or somebody else who is regularly doing mvn scala:doc
locally (and want to stay offline) would find that with "mvn site" (or
"mvn scala:doc" when the fix is in) you end up having the click thru to
different package classes land up somewhere in
http://scala-tools.org/mvnsites-snapshots/.... instead of local filesystem.
This is because, by default vscaladoc.links.liftweb.baseurl is set to
http://scala-tools.org/mvnsites-snapshots/liftweb. Adjust this using
"-Dvscaladoc.links.liftweb.baseurl=<local_lift_base>" during "mvn site"
to circumvent that.

Cheers, IRC

[Indrajit Raychaudhuri]

Tim,

A fix is up for review: http://reviewboard.liftweb.net/r/137/. This
resolved the scala:doc inconsistency among other things.

Cheers, Indrajit

On Nov 30, 11:42 pm, Indrajit Raychaudhuri <indraj...@gmail.com>
wrote:

> Short answer:
> Use "mvn site" for a couple of days to have the package link defs work,
> but ideally "mvn scala:doc" should be consistent. I'll fix that, give me
> a day or two please.
>
> Long answer:
> "mvn site" picks up plugin settings from reporting section and "mvn
> scala:doc" picks up plugin settings from build section. The trick
> (jvmArg -DpackageLinkDefs) is done in the maven-scala-plugin
> configuration in the reporting section. Per Maven's documentation build
> plugin settings (and thus config) should be picked up from their
> corresponding settings in reporting section (odd, but true). Strangely,
> that's happening for all the config elements except for <jvmArgs/>.
> So I'll go ahead and duplicate <jvmArgs/> section in both places:report
> plugin and build plugin.
>
> Pain:
> Next up, you, or somebody else who is regularly doing mvn scala:doc
> locally (and want to stay offline) would find that with "mvn site" (or
> "mvn scala:doc" when the fix is in) you end up having the click thru to

> different package classes land up somewhere inhttp://scala-tools.org/mvnsites-snapshots/.... instead of local filesystem.
> This is because, by default vscaladoc.links.liftweb.baseurl is set tohttp://scala-tools.org/mvnsites-snapshots/liftweb. Adjust this using

> >> For more options, visit this group athttp://groups.google.com/group/liftweb?hl=en.