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

scaladoc: extempore gripes

1 reply
extempore
Joined: 2008-12-17,
User offline. Last seen 35 weeks 3 days ago.

The consensus seems to be to send this kind of thing to
scala-internals, but I keep forgetting when it comes to messages like
the below. Bet you didn't fully appreciate what was meant by
"-internals", did you!

---------- Forwarded message ----------
From: Paul Phillips
Date: Sun, Feb 5, 2012 at 10:46 PM
Subject: scaladoc

Can we please have some kind of scaladoc mode which does not fail the
build over trivial issues? Or better yet, I'll drop everything to cut
it out of trunk and put it in its own repository, where someone else
can deal with it.  The toll exacted by this sort of thing should have
been unacceptable long ago.  This appears to be failing the whole
build over the mention of @usecase within a comment.

docs.comp:
  [mkdir] Created dir:

 [scaladoc] Documenting 462 source files to

 [scaladoc] :76:
error: expected start of definition
 [scaladoc]    *  @usecase or the end of the string, as they might
include other sections
 [scaladoc]                ^
 [scaladoc] :1617:
Document failed with 1 error; see the documenter error output for
details.
 [scaladoc]     at
scala.tools.ant.ScalaTask$class.buildError(ScalaMatchingTask.scala:27)
 [scaladoc]     at
scala.tools.ant.ScalaMatchingTask.buildError(ScalaMatchingTask.scala:30)

Viktor Klang
Joined: 2008-12-17,
User offline. Last seen 1 year 27 weeks ago.
Re: scaladoc: extempore gripes

+1

On Feb 6, 2012 7:49 AM, "Paul Phillips" <paulp@improving.org> wrote:
The consensus seems to be to send this kind of thing to
scala-internals, but I keep forgetting when it comes to messages like
the below. Bet you didn't fully appreciate what was meant by
"-internals", did you!

---------- Forwarded message ----------
From: Paul Phillips <paulp@improving.org>
Date: Sun, Feb 5, 2012 at 10:46 PM
Subject: scaladoc

Can we please have some kind of scaladoc mode which does not fail the
build over trivial issues? Or better yet, I'll drop everything to cut
it out of trunk and put it in its own repository, where someone else
can deal with it.  The toll exacted by this sort of thing should have
been unacceptable long ago.  This appears to be failing the whole
build over the mention of @usecase within a comment.


docs.comp:
  [mkdir] Created dir:
<https://scala-webapps.epfl.ch/jenkins/job/scala-checkin/ws/build/scaladoc/compiler>
 [scaladoc] Documenting 462 source files to
<https://scala-webapps.epfl.ch/jenkins/job/scala-checkin/ws/build/scaladoc/compiler>
 [scaladoc] <https://scala-webapps.epfl.ch/jenkins/job/scala-checkin/ws/src/compiler/scala/tools/nsc/util/DocStrings.scala>:76:
error: expected start of definition
 [scaladoc]    *  @usecase or the end of the string, as they might
include other sections
 [scaladoc]                ^
 [scaladoc] <https://scala-webapps.epfl.ch/jenkins/job/scala-checkin/ws/build.xml>:1617:
Document failed with 1 error; see the documenter error output for
details.
 [scaladoc]     at
scala.tools.ant.ScalaTask$class.buildError(ScalaMatchingTask.scala:27)
 [scaladoc]     at
scala.tools.ant.ScalaMatchingTask.buildError(ScalaMatchingTask.scala:30)

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