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 generates incorrect source links to Java source files #5388

Closed
scabug opened this issue Jan 18, 2012 · 4 comments
Closed

Scaladoc generates incorrect source links to Java source files #5388

scabug opened this issue Jan 18, 2012 · 4 comments

Comments

@scabug
Copy link

scabug commented Jan 18, 2012

in ModelFactory.sourceUrl, it does .stripSuffix(".scala") , so when you specify -doc-source-url when calling Scaladoc you have to add the .scala back in to the URL, except then that means any links to Java source files end up as ".java.scala" instead of just ".java"

@scabug
Copy link
Author

scabug commented Jan 18, 2012

Imported From: https://issues.scala-lang.org/browse/SI-5388?orig=1
Reporter: @SethTisue
Affected Versions: 2.9.1

@scabug
Copy link
Author

scabug commented Jan 18, 2012

@SethTisue said:
workaround: postprocess the HTML files, replacing ".java.scala" with ".java"

ennru added a commit to ennru/scala that referenced this issue Dec 20, 2018
Introduces new variables for -doc-source-url

    FILE_PATH_EXT - same as FILE_PATH, but including the file extension (which might be .java)
    FILE_EXT - the file extension (.scala or .java)
    FILE_LINE - containing the line number of the Symbol

Fixes FILE_PATH to never contain the file extension (see scala/bug#5388)
ennru added a commit to ennru/scala that referenced this issue Dec 21, 2018
Introduces new variables for -doc-source-url

    FILE_PATH_EXT - same as FILE_PATH, but including the file extension (which might be .java)
    FILE_EXT - the file extension (.scala or .java)
    FILE_LINE - containing the line number of the Symbol

Fixes FILE_PATH to never contain the file extension (see scala/bug#5388)
ennru added a commit to ennru/scala that referenced this issue Dec 21, 2018
…o source

Introduces new variables for -doc-source-url

    FILE_PATH_EXT - same as FILE_PATH, but including the file extension (which might be .java)
    FILE_EXT - the file extension (.scala or .java)
    FILE_LINE - containing the line number of the Symbol

Fixes FILE_PATH to never contain the file extension (see scala/bug#5388)
@lrytz lrytz modified the milestones: Backlog, 2.12.9 Dec 21, 2018
@SethTisue
Copy link
Member

scala/scala#7532 (2.13), scala/scala#7559 (2.12)

Enno thanks for fixing the bug I reported in 2012 :-)

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

4 participants