Issue 17059: Revise comments in code/model for clarity in TacsitController.getEntityTypes (tacsit-ftf)
Source: SimVentions (Mr. Matthew Wilson, mwilson(at)simventions.com)
Nature: Uncategorized Issue
Severity: 
Summary: The comment for this method reads:
             /**
	 * Return the Entity Types which are supported by the TACSIT. This will
	 * return a list of all Entity Types currently available for Selection and
	 * Query by this TACSITController
	 * 
	 * @return 
	 */

The first sentence gives the impression that it will return anything that can possibly be in the TacsitController. The second sentence implies only entities that currently exist in the TacsitController.

Resolution:
It seems likely that the first sentence is correct; the wording of the second sentence should be changed to “This will return a list of all Entity Types available for Selection and Query by this TACSITController”.

Revised Text:
 Change the comments in paragraph 7.1.1.8.2 and the model to read:
Returns the Entity Types that are supported by the TAC SIT. This will return a list of all Entity Types available for Selection and Query by this TACSITController.

Resolution: 
Revised Text: 
Actions taken:
January 26, 2012: received issue
Discussion: 

End of Annotations:=====
s is issue # 17059


OMG Issue No:  17059
Title:   Revise comments in code/model for clarity in TacsitController.getEntityTypes
 
Source:
Matt Wilson - mwilson@simventions.com
 
Severity: Support Text 
 

Summary:   

 
The comment for this method reads:
             /**
                 * Return the Entity Types which are supported by the TACSIT. This will
                 * return a list of all Entity Types currently available for Selection and
                 * Query by this TACSITController
                 * 
                 * @return 
                 */
 
The first sentence gives the impression that it will return anything that can possibly be in the TacsitController. The second sentence implies only entities that currently exist in the TacsitController.
 
Resolution:
It seems likely that the first sentence is correct; the wording of the second sentence should be changed to .This will return a list of all Entity Types available for Selection and Query by this TACSITController..
 
Revised Text:
 Change the comments in paragraph 7.1.1.8.2 and the model to read:
Returns the Entity Types that are supported by the TAC SIT. This will return a list of all Entity Types available for Selection and Query by this TACSITController.