Implementing and documenting a class

Data Structures

In this assignment, the student will implement a class and use the doxygen documentation facility to document it. Javadocs can also be used if java is the preferred language. The assignment is written for a specific class to be implemented in the context of a larger project and should be modified to account for using other classes or project.

Gerald Gannod

comments, documentation, code

One Week

writing

implementation, coding

Scenario: You have been assigned the task of both writing and documenting the behavior of a class.

Communication Audience: Other developers and potential maintainers

Deliverables: Source code with embedded comments plus generated html documentation of the source

How it will be used: The documentation will be used to understand how to use the code

N/A