ETAMainModel.Inspect()
 
Software Inspection Report Document
Reviewer: Mike Power
Author: Wes Strickland
Work Product: ETAMainModel.inspect(Object, boolean)

Mental White Box Testing: The method has no if's, loops,
or any other control structure.
Looking over the code I see that it can't handle null.
Calling inspect on inspect when inspect is null would
also cause a failure. It is not documented in the pre
condition that view should be none null.

Coding Standard Checking: The coding standard for
inspect is completely up to par. "{" is on the line
after the method signature lined up with the first
column of the method signature. The method itself
is indented the correct 4 spaces also the code is
indented 4 spaces beyond that. Both agreeing with
standard. I found no tabs used. There is not
space between method calls and the parameters
passed to that method, which again adheres to
standard. All coding style is up to par.

Maintainability Checking: All required fields
are present; description, pre-conditions, post
conditions, param description. There is no need
for a return since this method has none. I do
not like the quality of the fields. I feel that
the description of the method is short and leaves
much needed information out. As described early
I think this method needs a proper pre-condition
to so effect of requiring inspect to be none null.
There should be some form of post-condition in my
mind, doesn't the call inspect.inspect(obj,
editable) change in some way the state of the
ETAMainModel? The description of the Object
param could use a touch up. Although it will
do in my mind for now. The description of the
boolean however I find vague and doesn't really
describe what it is really doing.


Reviewer: Mike Power Reviewee: Wes Strickland

ETAMainModel.Inspect()

1. Add pre-condition that Inspect is not null.

2. Add to description.

3. Add post-condition.
Issue# Description Acceptance
1  Add pre-condition that Inspect is not null.  Accept 
2  Add to description.  Accept 
3  Add post-condition.  Accept 

Software Inspection Summary
Technical Defects Reported 0  Documentation Defects Reported 3  Coding Standard Defects Reported 0 
Total Number of Defects 3  Overall Summary Pass or Fail Fail