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

it'd sure be nice if Scaladoc processed doc comments in Java source files #4826

Closed
scabug opened this Issue Jul 22, 2011 · 8 comments

Comments

Projects
None yet
2 participants
@scabug
Copy link

scabug commented Jul 22, 2011

Scaladoc already processes Java sources and produces Scaladoc for them.
It just ignores the doc comments.

Many of our Scala codebases have at least some Java in them for various reasons.
It'd be SUPER AWESOME (well, "nice" at least) if Scaladoc could generate full documentation for these
mixed codebases, including all doc comments.

It appears this was added briefly by Donna in r22605, then reverted in r22619.

@scabug

This comment has been minimized.

Copy link

scabug commented Jul 22, 2011

@scabug

This comment has been minimized.

Copy link

scabug commented Jul 25, 2011

Pedro Furlanetto (pedrofurla) said:
This is the message for r22619:
"Revert 22605 change to JavaParsers?.scala, which modified parsing behavior and broke jvm test t3415. No longer create DocDef? nodes for Javadoc comments in Java source files. No review."

I wonder if t3415 would be easily fixable.

Scala Reviewer, I'd like to give a shoot on this one.

@scabug

This comment has been minimized.

Copy link

scabug commented Sep 2, 2011

Markus Kahl (machisuji) said:
Any updates on this issue?

@scabug

This comment has been minimized.

Copy link

scabug commented Jul 10, 2013

@adriaanm said:
Unassigning and rescheduling to M6 as previous deadline was missed.

@scabug

This comment has been minimized.

Copy link

scabug commented Nov 18, 2013

Margaret Leber (MaggieL) said:
Ah, the parade of fix versions...:-)

@scabug

This comment has been minimized.

Copy link

scabug commented Nov 18, 2013

Pedro Furlanetto (pedrofurla) said:
A simple solutions would be to process Java files using a custom Doclet[1][2] and convert/adapt the Javadoc model to the Scaladoc model. Once we have a Scaladoc model of the Javadoc comments, it's just a matter of letting Scaladoc generate the documents.

Thoughts?

[1] http://docs.oracle.com/javase/1.5.0/docs/guide/javadoc/doclet/overview.html
[2] http://docs.oracle.com/javase/1.5.0/docs/guide/javadoc/doclet/spec/index.html

@scabug

This comment has been minimized.

Copy link

scabug commented Nov 18, 2013

@SethTisue said (edited on Nov 18, 2013 8:44:33 PM UTC):
That sounds like you're trying to generate Scaladoc from Javadoc comments in Java sources.

What I had in mind was to generate Scaladoc from Scaladoc comments in Java sources.

I'm sure there are advantages both ways. But a huge advantage of the latter approach is that I would think it would be easier to do, since Scaladoc already understands Scaladoc format, but doesn't know the Javadoc format.

Without going back and looking, I'm not sure which approach r22605 actually took.

@scabug

This comment has been minimized.

Copy link

scabug commented Jul 18, 2016

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