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

Jump to bottom

scaladoc should use a separate -doc-sourcepath option #5763

Closed
scabug opened this issue May 4, 2012 · 2 comments
Closed

scaladoc should use a separate -doc-sourcepath option #5763

scabug opened this issue May 4, 2012 · 2 comments
Assignees
@VladUreche
Labels
scaladoc tool
Milestone
2.10.0-M3

Comments

@scabug
Copy link

scabug commented May 4, 2012 •
edited by retronym

Scaladoc can determine the relative source path for a symbol if -sourcepath is defined and use that to link to the source. However, -sourcepath has unintended side effects and can break compilation. (See this thread.) Scaladoc should instead use its own -doc-sourcepath option. Alternatively, what is currently called -sourcepath should be renamed and hidden behind -X as suggested in the thread.
@scabug
Copy link
Author

scabug commented May 4, 2012

Imported From: https://issues.scala-lang.org/browse/SI-5763?orig=1
Reporter: @harrah

@scabug
Copy link
Author

scabug commented Jun 13, 2012

@VladUreche said (edited on Jun 13, 2012 10:56:29 PM UTC):
Fixed in 94db9d983c.
EDIT: When using scaladoc, -sourcepath bootstrapping is disabled, thus there's no need for a new name. Keeping the same name avoids breaking existing scripts or having to remove deprecated members in a future release.

@scabug scabug closed this as completed Jun 13, 2012
@scabug scabug added this to the 2.10.0-M3 milestone Apr 7, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@VladUreche VladUreche

Labels
scaladoc tool
Projects
None yet
Milestone
2.10.0-M3
Development

No branches or pull requests
2 participants
@VladUreche @scabug