Skip to content
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.

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

scaladoc should not expand def macros (in most cases) #6812

Closed
scabug opened this issue Dec 13, 2012 · 6 comments
Closed

scaladoc should not expand def macros (in most cases) #6812

scabug opened this issue Dec 13, 2012 · 6 comments

Comments

@scabug
Copy link

@scabug scabug commented Dec 13, 2012

scaladoc does not support separate generation of documentation, so the sources for all modules in a project need to be passed to scaladoc at once. For a project that defines a macro in one module and uses it in another, this violates the rule that macro definitions must be separate from their usage.

One way to get around this is for scaladoc to not expand macros. There may some cases where it has to expand them, but in general, scaladoc doesn't need to inspect the implementation of a method if the return type is given explicitly. This is a reasonable restriction for those who otherwise cannot generate documentation for their macro-enabled project.

@scabug
Copy link
Author

@scabug scabug commented Dec 13, 2012

Imported From: https://issues.scala-lang.org/browse/SI-6812?orig=1
Reporter: @harrah
Affected Versions: 2.10.0-RC5, 2.11.0-M1

@scabug
Copy link
Author

@scabug scabug commented Jan 15, 2013

@adriaanm said:
Eugene, could you have a look at this? Thanks!

@scabug
Copy link
Author

@scabug scabug commented Jan 30, 2013

@xeno-by said:
Yep, looking into this issue.

@scabug
Copy link
Author

@scabug scabug commented Jan 30, 2013

@scabug
Copy link
Author

@scabug scabug commented Feb 2, 2013

@scabug scabug closed this Feb 2, 2013
@scabug
Copy link
Author

@scabug scabug commented Feb 13, 2013

@harrah said:
I'm now able to generate API docs for a multi-project build with macros: scala-sbt.org/api. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants