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 link to external projects #191

Closed
scabug opened this issue Oct 18, 2007 · 9 comments
Closed

ScalaDoc link to external projects #191

scabug opened this issue Oct 18, 2007 · 9 comments

Comments

@scabug
Copy link

scabug commented Oct 18, 2007

It would be highly useful to allow ScalaDoc to link particular packages (e.g., net.liftweb.*) to external URLs such that creating ScalaDoc for a lift project would allow linking to the (soon to be) publicly available ScalaDocs for lift as well as the JavaDocs for Servlet, etc.

If you want a more formal specification (rather than a random wish), I'll be happy to provide suggestions about command line arguments.

Also, I don't know if this component is nsc (the compile) or something else, so sorry if I mis-categorized it.

@scabug
Copy link
Author

scabug commented Oct 18, 2007

Imported From: https://issues.scala-lang.org/browse/SI-191?orig=1
Reporter: David Pollak (dpp)

@scabug
Copy link
Author

scabug commented Nov 24, 2007

@mcdirmid said:
This sounds like something Stephane was working on. Really Scaladoc needs a big upgrade to support external linking, I'm not sure if its worth the effort to do with static HTML pages. It might be better to reuse Scaladoc's formatting capabilities in something that is more flexible and dynamic than static pre-generated HTML pages. If only Scala had a web framework!

@scabug
Copy link
Author

scabug commented Jan 14, 2009

@odersky said:
Milestone postponed deleted

@scabug
Copy link
Author

scabug commented Feb 23, 2011

@dubochet said:
Duplicate of #3884.

@scabug
Copy link
Author

scabug commented Aug 7, 2011

@harrah said:
#3884 concerns adding links to non-API documentation. This bug requests the much needed ability to automatically link to other API documentation not generated at the same time.

@scabug
Copy link
Author

scabug commented Aug 8, 2011

@kzys said (edited on Aug 8, 2011 1:57:31 AM UTC):
+1

Maybe we should generate something like Map[packagePrefix: String, howToLink].

@scabug
Copy link
Author

scabug commented Sep 19, 2011

@soc said:
I'm working on something like that.

It is configurable with a config file (XML currently) making it possible for people to add more sites without recompiling the compiler. It supports user-supplied regular expressions for matching, transforming and building the necessary URLs and is flexible enough to support various documentation tools (not only JavaDoc).

One problem are Java inner classes though. It seems there is no way to actually recognize them and tell them apart from another package level at the place we currently handle them.

@scabug
Copy link
Author

scabug commented Mar 20, 2012

@VladUreche said:
Hi Simon,

Any progress on this? #5350 suggests using -link, like in Javadoc. Will mark it as a duplicate.

@scabug
Copy link
Author

scabug commented Mar 26, 2012

@VladUreche said:
Tentatively assigning to Manohar, but this one might not make it into 2.10.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants