Grouper Developers Forum

["Hyzer, Chris" <>]

I committed the Javadoc.  Sorry your time was wasted.  I don't really order 
my Javadoc params, you will find lots of instances of this.  Are you using an 
IDE that prompts you for each param?  Maybe that would help...

-----Original Message-----
From: 

 
[mailto:]
 On Behalf Of Black, Carey M.
Sent: Tuesday, August 14, 2018 2:58 AM
To: 

Subject: [grouper-dev] Doc bug... misc/GrouperCheckConfig.java

I know this is "picky" ( and has been broken for a while ), it is also almost 
3 AM and it took me over an hour to find this bug...... ( I now have less 
hair than I started with. )

Please correct the Javadoc.


/grouper/src/grouper/edu/internet2/middleware/grouper/misc/GrouperCheckConfig.java
......

/**
   * make sure an attribute is there or add it if not
   * @param stem
   * @param attributeDef 
   * @param extension
   * @param description
   * @param logAutocreate 
   * @return the attribute def name
   */
  private static AttributeDefName checkAttribute(Stem stem, AttributeDef 
attributeDef, String extension, String description, boolean logAutocreate) {
    return checkAttribute(stem, attributeDef, extension, extension, 
description, logAutocreate);
  }


THEN... you injected "displayExtension" BEFORE  "description" on the 
signature of the next Method. (WT???? append to the end.... always 
append.....)
AND the order of the @param values in the method Javadoc is not the same 
order as the method. ( Since they are just "strings" it is very easy to NOT 
get what you want from the method. )
 
/**
   * make sure an attribute is there or add it if not
   * @param stem
   * @param attributeDef 
   * @param extension
   * @param description
   * @param displayExtension
   * @param logAutocreate 
   * @return the attribute def name
   */
  private static AttributeDefName checkAttribute(Stem stem, AttributeDef 
attributeDef, String extension, String displayExtension, String description, 
boolean logAutocreate) {
....


-- 
Carey Matthew