Uploaded image for project: 'Service Packs and Hot Fixes'
  1. Service Packs and Hot Fixes
  2. MNT-13545

JavaDoc : Inconsistencies between the Java doc and the actual code

    Details

      Description

      There are inconsistencies in the Javadoc regarding some lists of parameters methods take.

      For example in class org.alfresco.repo.invitation.InviteHelper :

      /**
           * Add Invitee to Site with the site role that the inviter "started" the invite process with
           * @param invitee
           * @param siteName
           * @param role
           * @param runAsUser
           * @param siteService
           * @param overrideExisting
           */
          public void addSiteMembership(final String invitee, final String siteName, final String role, final String runAsUser, final boolean overrideExisting)
      

      This method doesn't take any parameter called siteService.

      Discussing with Samuel, it seems that we are getting thousands of warnings when we are generating the Javadocs, most likely due to inconsistencies of this type.

        Attachments

        1. alf502javadocresult-2015-06-09.txt
          26 kB
          Martin Bergljung
        2. Constructing Javadoc information in IDEA - result - 2015-06-09.txt
          37 kB
          Martin Bergljung
        3. javadoc.log
          883 kB
          Samuel Langlois [X]
        4. JavaDoc.xml
          94 kB
          Alfresco QA Team
        5. JavaDocResults.txt
          73 kB
          Alfresco QA Team

          Structure

            Activity

              People

              • Assignee:
                closedbugs Closed Bugs
                Reporter:
                jmesurolle Julien Mesurolle [X] (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                12 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 4 weeks, 1 day, 1 hour, 30 minutes
                  4w 1d 1h 30m

                    Structure Helper Panel