- About Scala
- In the Enterprise
- Scala Community
- Language Research
- In the Press
- The Scala Team
- Scala's Prehistory
- Contact Us
- Learning Scala
- Tour of Scala
- Scala API
- Setup & Getting Started
- Programming Guides
- Other Guides
- Code Examples
- Scala Developers
Where to place Scaladoc macros with package-wide visibility?
Wed, 2011-10-26, 20:53
Scaladoc macros work fine for classes, traits and objects. On
https://wiki.scala-lang.org/display/SW/Tags+and+Annotations we may
read: "When $name is used in comments of the class, trait, object *or
package* (including those of members), it will be replaced..."
Now I need a macro to be invoked in the Scaladoc comment of several
classes within a single package so I think I can define the macro in
the Scaladoc of that package. So far I've tried to place the macro in
1) Scaladoc of the package in package.scala
2) Scaladoc of the package object in package.scala
3) Scaladoc within the package object in package.scala
4) Scaladoc of the package declaration of the source file containing
but none of these helped - the macro will not be picked up and invoked
using SBT 0.10 doc.
Do you know where to place a package-wide macro definition?