Uploaded image for project: 'OpenJPA'
  1. OpenJPA
  2. OPENJPA-2576

fix broken JavaDoc

        Details

        • Type: Bug
        • Status: Closed
        • Priority: Major
        • Resolution: Fixed
        • Affects Version/s: 2.3.0
        • Fix Version/s: 2.4.0
        • Component/s: build / infrastructure
        • Labels:
          None

          Description

          Our code is full with broken JavaDocs. I already removed @return statements without any further description.
          We should also get rid of @param without any comments and wrong @param declarations. We have about 500 such issues and JavaDoc is totally freaking out.

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            jira-bot ASF subversion and git services added a comment -

            Commit 1671792 from Mark Struberg in branch 'openjpa/trunk'
            [ https://svn.apache.org/r1671792 ]

            OPENJPA-2576 remove @nonjava which is actually not a javadoc tag

            Show
            jira-bot ASF subversion and git services added a comment - Commit 1671792 from Mark Struberg in branch 'openjpa/trunk' [ https://svn.apache.org/r1671792 ] OPENJPA-2576 remove @nonjava which is actually not a javadoc tag
            Hide
            Permalink
            struberg Mark Struberg added a comment -

            I've also fixed the creation of javadoc during a release. When releasing we create javadoc separately for each jar.
            If we build javadoc for publishing the site we have a -Pjavadoc-profile which builds one aggregated javadoc jar though.

            Show
            struberg Mark Struberg added a comment - I've also fixed the creation of javadoc during a release. When releasing we create javadoc separately for each jar. If we build javadoc for publishing the site we have a -Pjavadoc-profile which builds one aggregated javadoc jar though.
            Hide
            Permalink
            jira-bot ASF subversion and git services added a comment -

            Commit 1674154 from Mark Struberg in branch 'openjpa/trunk'
            [ https://svn.apache.org/r1674154 ]

            OPENJPA-2576 fix broken JavaDocs

            Show
            jira-bot ASF subversion and git services added a comment - Commit 1674154 from Mark Struberg in branch 'openjpa/trunk' [ https://svn.apache.org/r1674154 ] OPENJPA-2576 fix broken JavaDocs
            Hide
            Permalink
            struberg Mark Struberg added a comment -

            Fixed quite a bit. Still many things pen still. We need a follow up ticket.

            Show
            struberg Mark Struberg added a comment - Fixed quite a bit. Still many things pen still. We need a follow up ticket.

              People

              • Assignee:
                struberg Mark Struberg
                Reporter:
                struberg Mark Struberg
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Development