My favorites | Sign in
Project Home Wiki Issues Source
READ-ONLY: This project has been archived. For more information see this post.
Search
for
  Advanced search   Search tips   Subscriptions
Issue 6: Documentation
  Back to list
Status:  Done
Owner:  wingles....@gmail.com
Closed:  Mar 2012


 
Project Member Reported by wingles....@gmail.com, Mar 9, 2012
Use Doxygen to document the interfaces.
The above documentation only needs to be generated from Grades.h.
Comment each function meaningfully.
Use comments only if you need to explain the why of a particular implementation.
Choose a coding convention and be consistent.
Use good variable names.
Write readable code with good indentation, blank lines, and blank spaces.
Mar 19, 2012
Project Member #1 wingles....@gmail.com
Added couple of comments and function descriptions to functions in grades.h.

Status: Started
Mar 22, 2012
Project Member #2 wingles....@gmail.com
Documentation over Grades.h has been created using Doxygen.
Mar 22, 2012
Project Member #3 wingles....@gmail.com
(No comment was entered for this change.)
Status: Done

Powered by Google Project Hosting