matcatc / Test_Parser

parses and displays the output from test logs
http://matcatc.github.com/Test_Parser
GNU General Public License v3.0
1 stars 0 forks source link

precondions, postconditions #22

Closed matcatc closed 14 years ago

matcatc commented 14 years ago

Should we document/code any preconditions/postconditions?

Some of the doxygen comments cover this already...

matcatc commented 14 years ago

Start by documenting all precoditions and postconditions.

We can use a framework or similar later to actually check them if we desire.

matcatc commented 14 years ago

Added documentation for preconditions. I didn't really see many of them. Didn't find a single postcondition.

There doesn't seem to be very many pre/post conditions that are really big (like with a mathematical algorithm.) I don't think any of them need/deserve actual checking in code. It would only complicate things and take time away from actual progress. Plus we can add more later.