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

Scala source code to javadoc #27

Open
GeTOUO opened this issue Jul 15, 2019 · 5 comments
Open

Scala source code to javadoc #27

GeTOUO opened this issue Jul 15, 2019 · 5 comments

Comments

@GeTOUO
Copy link

GeTOUO commented Jul 15, 2019

Do you support compiling and exporting from Scala source code to javadoc?

@SethTisue
Copy link

sounds like you're looking for https://github.com/lightbend/genjavadoc

@GeTOUO
Copy link
Author

GeTOUO commented Jul 15, 2019

Thank you for your suggestion. In fact, I encountered some problems using genjavadoc.

My project was built by maven. I called Javadoc during compile phase and inserted other subtasks in Javadoc (generating json-formatted descriptions through doc content). Ultimately, I'll use these JSON data in my restapi documentation.

My problem is:

The Java class generated by genjavadoc can't be compiled, which will cause my build to fail.

@SethTisue
Copy link

SethTisue commented Jul 15, 2019

The Java class generated by genjavadoc can't be compiled, which will cause my build to fail

you think there's a bug in genjavadoc, then? (is there a ticket on that?)

if you're looking for a substitute for genjavadoc, I highly doubt anything else provides similar functionality, I can't be certain nothing exists, but I don't know why someone would build it, given that genjavadoc exists

@SethTisue
Copy link

oh, I see we were already discussing this at lightbend/genjavadoc#181

@GeTOUO
Copy link
Author

GeTOUO commented Jul 15, 2019

Yes. When I found genjavadoc, I was very happy. It helped my Scala code go through the Javadoc stage and let me extract the data I needed, but after using it, I found that I could not. Because I need to use genjavadoc translated Java classes in the compilation phase to generate new data in the Javadoc phase, but I can't compile it. Then, when I tried to dig deeper, I found that I couldn't move forward and find an effective way because I knew very little about scala plug-ins. I consulted scaladoc and SBT documents, hoping to find an instance abstraction about scaladoc, and then output my JSON in genjavadoc's life cycle. Data, but I still failed.

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

No branches or pull requests

2 participants