I Hate scaladoc

Rodrigo Cano

unread,

Dec 21, 2012, 2:39:05 PM12/21/12

to scala-user

I can never generate a scaladoc without it exploding somehow (this comes from many times that I've tried to use it during my life with scala, since 2.8 all the way to 2.10-RC5).

Normally it takes me a while changing code until it finally parses it instead of crushing (with the most basic syntax.. I really wonder how did the guy/s of scalatest to write such beautiful documentation), but this time I am getting this error which I can't overcome:

[error] (luthier-core/compile:doc) 'method registeredFlows_=' isn't a class, trait or object thus cannot be built as a documentable template.

The field it is complaining about is defined as:

@volatile var registeredFlows = Set.empty[GFlow]

and it is NOT documented in any way (although, I would like to comment it, since its public).

If I, some how remove that field, another var causes it to explode. Are vars that broken for scaladoc?. I'm using scala2.10.RC5 for this project. Anyway to make it work?.

Thanks, and sorry for the tone of my frustration.

Daniel Sobral

unread,

Dec 21, 2012, 3:49:39 PM12/21/12

to Rodrigo Cano, scala-user

Can you minimize the problem?

--
Daniel C. Sobral

I travel to the future all the time.

Rodrigo Cano

unread,

Dec 21, 2012, 3:56:24 PM12/21/12

to Daniel Sobral, scala-user

No, I really tried, but have no idea of what triggers it... I'm pushing here to opensource the project we are working in asap, but it might take some time, sorry. I thought that somebody would already hit this, and not that I'm just this unlucky.

Dave

unread,

Dec 22, 2012, 5:48:42 AM12/22/12

to scala...@googlegroups.com

Which build tool (and version) are you using? It might be a build tool problem.

Op vrijdag 21 december 2012 20:39:05 UTC+1 schreef Rodrigo Cano het volgende:

Rodrigo Cano

unread,

Dec 23, 2012, 10:09:14 AM12/23/12

to Dave, scala...@googlegroups.com

sbt 12.1

Dave

unread,

Dec 23, 2012, 10:40:06 AM12/23/12

to scala...@googlegroups.com, Dave

I think if I look in their trunk scalatest is using ant/maven.
You could use ant for generating scaladoc, maybe it works better in particular with annotations (I had some unchecked warnings (although harmless, probably) with DI annotations in sbt, but not in maven).
Here is a basic build.xml that you could customize (e.g. use it only for scaladoc)
http://www.steinbit.org/words/programming/setting-up-ant-for-your-scala-project

For scala 2.10, you need to add scala-reflect.jar , because most of the reflection is now in a separate jar
<property name="scala-reflect.jar" location="${scala.dir}/lib/scala-reflect.jar"/>

and use it in this part

   <path id="scala.classpath">
      <pathelement location="${scala-compiler.jar}"/>
      <pathelement location="${scala-library.jar}"/>
      <pathelement location="${scala-reflect.jar}"/>
    </path>

Op zondag 23 december 2012 16:09:14 UTC+1 schreef Rodrigo Cano het volgende:

Rodrigo Cano

unread,

Dec 23, 2012, 12:52:16 PM12/23/12

to Dave, scala...@googlegroups.com

Thanks, I'll try that out.

Vlad Ureche

unread,

Dec 23, 2012, 7:47:59 PM12/23/12

to Rodrigo Cano, scala-user, Eugene Vigdorchik

On Fri, Dec 21, 2012 at 8:39 PM, Rodrigo Cano <ioni...@gmail.com> wrote:

[error] (luthier-core/compile:doc) 'method registeredFlows_=' isn't a class, trait or object thus cannot be built as a documentable template.

The field it is complaining about is defined as:

@volatile var registeredFlows = Set.empty[GFlow]

and it is NOT documented in any way (although, I would like to comment it, since its public).

If I, some how remove that field, another var causes it to explode. Are vars that broken for scaladoc?. I'm using scala2.10.RC5 for this project. Anyway to make it work?.

Hi Rodrigo,

Can you please post the stacktrace you got for the error? In the absence of the source code which triggers it, a stack trace would be the next most useful thing.

Btw, unfortunately now it's too late in the Scala 2.10.0 release process to have a patch merged, but I can try to come up with a workaround so you get things running for 2.10.0 and later get a fix in for 2.10.1. I just need to reproduce the error.

A couple more questions:

- if you replace the variable definition by:
@volatile private[this] var _registeredFlows = Set.empty[GFlow]
def registeredFlows = _registeredFlows
def registeredFlows_= (v: Set[GFlow]) = _registeredFlows = v
do you still see the error? (this is the expasion Scala does for the variable, exposing the getter and setter)
- are you using the "-expand-all-types" scaladoc flag?
- do you have any doc comment for the variable? If so, does it contain "@template" or "@documentable"?
- is this variable defined in a package object?

Cheers,
Vlad

Rodrigo Cano

unread,

Dec 24, 2012, 1:41:12 PM12/24/12

to Vlad Ureche, scala-user, Eugene Vigdorchik

Stacktrace:

java.lang.RuntimeException: 'method registeredFlows_=' isn't a class, trait or object thus cannot be built as a documentable template.

at scala.sys.package$.error(package.scala:27)

at scala.tools.nsc.doc.model.ModelFactory$modelCreation$.createDocTemplate$1(ModelFactory.scala:706)

at scala.tools.nsc.doc.model.ModelFactory$modelCreation$.createTemplate(ModelFactory.scala:752)

at scala.tools.nsc.doc.model.ModelFactory.scala$tools$nsc$doc$model$ModelFactory$$makeMember0$1(ModelFactory.scala:849)

at scala.tools.nsc.doc.model.ModelFactory.makeMember(ModelFactory.scala:862)

at scala.tools.nsc.doc.model.ModelFactory$DocTemplateImpl$$anonfun$8.apply(ModelFactory.scala:398)

at scala.collection.TraversableLike$$anonfun$flatMap$1.apply(TraversableLike.scala:251)

at scala.collection.immutable.List.foreach(List.scala:309)

at scala.collection.TraversableLike$class.flatMap(TraversableLike.scala:251)

at scala.collection.AbstractTraversable.flatMap(Traversable.scala:105)

at scala.tools.nsc.doc.model.ModelFactory$DocTemplateImpl.<init>(ModelFactory.scala:398)

at scala.tools.nsc.doc.model.ModelFactory$modelCreation$$anon$6.<init>(ModelFactory.scala:702)

at scala.tools.nsc.doc.model.ModelFactory$modelCreation$.createDocTemplate$1(ModelFactory.scala:702)

at scala.tools.nsc.doc.model.ModelFactory$modelCreation$.createTemplate(ModelFactory.scala:752)

at scala.tools.nsc.doc.model.ModelFactory.scala$tools$nsc$doc$model$ModelFactory$$makeMember0$1(ModelFactory.scala:849)

at scala.tools.nsc.doc.model.ModelFactory.makeMember(ModelFactory.scala:862)

at scala.tools.nsc.doc.model.ModelFactory$DocTemplateImpl$$anonfun$8.apply(ModelFactory.scala:398)

at scala.collection.TraversableLike$$anonfun$flatMap$1.apply(TraversableLike.scala:251)

at scala.collection.immutable.List.foreach(List.scala:309)

at scala.collection.TraversableLike$class.flatMap(TraversableLike.scala:251)

at scala.collection.AbstractTraversable.flatMap(Traversable.scala:105)

at scala.tools.nsc.doc.model.ModelFactory$DocTemplateImpl.<init>(ModelFactory.scala:398)

at scala.tools.nsc.doc.model.ModelFactory$PackageImpl.<init>(ModelFactory.scala:520)

at scala.tools.nsc.doc.model.ModelFactory$modelCreation$$anon$4.<init>(ModelFactory.scala:738)

at scala.tools.nsc.doc.model.ModelFactory$modelCreation$.createTemplate(ModelFactory.scala:738)