Documentation Format

Each of the projects has (or will have) documentation regarding things like individual classes as well as overall design patterns. Hopefully this page will provide a sufficient explanation of the format.


Class Diagrams

Class diagrams are used throughout the documentation of various classes (and the same format is used for structs also). The general format of the table is the following:

Class name
Variables and Properties
Constructors and Methods

Symbols

The class diagrams use various short-hand symbols to represent primarily protection levels.

Symbol Meaning
- A member with a "private" protection level.
# A member with a "protected" protection level.
+ A member with a "public" protection level.