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.

Sign up for GitHub

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

Fix sbt doc #172

Open
tdroxler opened this issue Apr 9, 2024 · 0 comments
Open

Fix sbt doc #172

tdroxler opened this issue Apr 9, 2024 · 0 comments

Comments

@tdroxler
Copy link
Member

tdroxler commented Apr 9, 2024 •
edited
Loading

In this PR we noticed that sbt doc was failing, more specifically this commit can be reverted to show the errors, there are two main problems:

  • inherited doc doesn't work in RalphLangServer
  • Links to external dependencies as well as java deps doesn't work

From the sbt doc , I'm not sure we can make java doc to work:

This situation results from scaladoc not processing Javadoc comments in Java sources nor linking to Javadoc

I also add issue to link to other sub modules, maybe worth checking here

test:doc generate a lot of discarding unmoored doc comment, I don't think it's really important to fix as we don't really need doc on our test, but here are some resources I found.
https://stackoverflow.com/questions/24932743/how-do-i-document-vals-in-pattern-definitions

scala/bug#8751
tdroxler added a commit that referenced this issue Apr 9, 2024
@tdroxler
Fix doc errors
a671a98 
There are links error on external lib as well a java lib.

We need `doc` to work for `sbt-native-packager`.

Issue #172 will take care of fixing all those docs.
@tdroxler tdroxler mentioned this issue Apr 9, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tdroxler