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

Programmatically generating links to @usecase'd members is painful. #9168

Closed
scabug opened this issue Feb 21, 2015 · 2 comments
Closed

Programmatically generating links to @usecase'd members is painful. #9168

scabug opened this issue Feb 21, 2015 · 2 comments

Comments

@scabug
Copy link

scabug commented Feb 21, 2015

Scaladoc uses @usecase annotations to output simplified entries for methods with scary signatures. See #5054

For symbols with @usecase annotations, the anchor link generated in the HTML output contains the text of the usecase signature, not the full signature.

This makes life difficult for external tools (IDEs) that want to generate links to specific Scala members. In the general case it is sufficient to use Symbol#signatureString to compute the anchor. However, for symbols with @usecases, one has to parse and understand the doc comments in order to form a working url, which is a pain.

Can we please emit a redundant anchor link for usecase entries, with the full signature? This would be backward compatible with all existing urls.

@scabug
Copy link
Author

scabug commented Feb 21, 2015

Imported From: https://issues.scala-lang.org/browse/SI-9168?orig=1
Reporter: Aemon Cannon (aemoncannon)
Affected Versions: 2.11.0, 2.11.1, 2.11.2, 2.11.4, 2.11.5

@SethTisue
Copy link
Member

@usecase was deprecated in 2.13.0

@SethTisue SethTisue closed this as not planned Won't fix, can't repro, duplicate, stale Feb 24, 2024
@SethTisue SethTisue removed this from the Backlog milestone Feb 24, 2024
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

3 participants