Skip to content

updates macro annotation docs #337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 18, 2014
Merged

updates macro annotation docs #337

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 2 additions & 9 deletions overviews/macros/annotations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,15 @@ languages: [ja]

**Eugene Burmako**

Macro annotations are only available in Scala 2.10 with the macro paradise plugin.
Their inclusion in Scala 2.11 is not planned, but it will possibly happen in Scala 2.12.
Macro annotations are only available in Scala 2.10.x and 2.11.x with the macro paradise plugin.
Their inclusion in official Scala might happen in Scala 2.12, but there is no certainty about it yet.
Follow the instructions at the ["Macro Paradise"](/overviews/macros/paradise.html) page to download and use our compiler plugin.

Note that macro paradise is needed both to compile and to expand macro annotations,
which means that your users will have to also add macro paradise to their builds in order to use your macro annotations.
However, after macro annotations expand, the resulting code will no longer have any references to macro paradise
and won't require its presence at compile-time or at runtime.

## Call for feedback

This implementation of macro annotations is experimental (hence the snapshot suffix in the current `2.0.0-SNAPSHOT` version
of macro-paradise) and exists to provide a preview and initiate a discussion that will culminate in submitting
a Scala improvement proposal for Scala 2.11 or 2.12. Please check whether it handles your code generation needs,
so that I can refine it appropriately. If something doesn't work, let me know <a href="https://twitter.com/#!/xeno_by">on Twitter</a>.

## Walkthrough

Macro annotations bring textual abstraction to the level of definitions. Annotating any top-level or nested definition with something
Expand Down