[MNT-13545] JavaDoc : Inconsistencies between the Java doc and the actual code Created: 04-Mar-15  Updated: 12-Feb-16  Resolved: 21-Aug-15

Status: Closed
Project: Service Packs and Hot Fixes
Component/s: SDK
Affects Version/s: 4.2.3, 5.0
Fix Version/s: 5.0.3

Type: Service Pack Request
Reporter: Julien Mesurolle [X] (Inactive) Assignee: Closed Bugs
Resolution: Fixed Votes: 0
Labels: Customer_Success
Remaining Estimate: 0 minutes
Time Spent: 4 weeks, 1 day, 1 hour, 30 minutes
Original Estimate: Not Specified

Attachments: Text File Constructing Javadoc information in IDEA - result - 2015-06-09.txt     XML File JavaDoc.xml     Text File JavaDocResults.txt     Text File alf502javadocresult-2015-06-09.txt     File javadoc.log    
Issue Links:
Related
Bug Priority:
Category 3
ACT Numbers:

00338900

Build Location: https://releases.alfresco.com/Enterprise-5.0/5.0.3/build-00084/ALL/

 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.


Generated at Sat Aug 15 21:38:09 BST 2020 using Jira 7.13.15#713015-sha1:7c5ddd2c3e1709974ae9c48c17df8edd3919fe2c.