Uploaded image for project: 'Scala Programming Language'
  1. Scala Programming Language
  2. SI-4826

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

    Details

      Description

      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.

        Attachments

          Issue Links

            Activity

            Hide
            pedrofurla Pedro Furlanetto added a comment -

            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.

            Show
            pedrofurla Pedro Furlanetto added a comment - 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.
            Hide
            machisuji Markus Kahl added a comment -

            Any updates on this issue?

            Show
            machisuji Markus Kahl added a comment - Any updates on this issue?
            Hide
            moors Adriaan Moors added a comment -

            Unassigning and rescheduling to M6 as previous deadline was missed.

            Show
            moors Adriaan Moors added a comment - Unassigning and rescheduling to M6 as previous deadline was missed.
            Hide
            MaggieL Margaret Leber added a comment -

            Ah, the parade of fix versions...

            Show
            MaggieL Margaret Leber added a comment - Ah, the parade of fix versions...
            Hide
            pedrofurla Pedro Furlanetto added a comment -

            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

            Show
            pedrofurla Pedro Furlanetto added a comment - 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
            Hide
            sethtisue Seth Tisue added a comment - - edited

            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.

            Show
            sethtisue Seth Tisue added a comment - - edited 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.
            Show
            moors Adriaan Moors added a comment - https://github.com/scala/scala/pull/5246

              People

              • Assignee:
                jodersky jodersky
                Reporter:
                sethtisue Seth Tisue
              • Votes:
                12 Vote for this issue
                Watchers:
                12 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: