|
|
Currently, I'm not accepting any contributions to the code base, since it's still in very early development phase. However, if you still want to help out and assuming you have a good understanding of the code base, you can help me add documentation to this wiki. Here are some guidelines to keep in mind for contributing:
|
|
|
|
|
|
##Class Pages:
|
|
|
## Class Pages:
|
|
|
* Start with a small introduction about the class itself, and some basic overview of what it does.
|
|
|
* Secondly use this header to document about what the constructor and the destructor does:
|
|
|
|
|
|
####Constructor and Destructor:
|
|
|
#### Constructor and Destructor:
|
|
|
* To document the member variables and member functions, use a table of these formats:
|
|
|
|
|
|
####Member variables:
|
|
|
#### Member variables:
|
|
|
|Name|Type|Visibility|Description|
|
|
|
|-------------|----|----------|-----------|
|
|
|
|
|
|
####Member functions:
|
|
|
#### Member functions:
|
|
|
|Name|Return Type|Visibility|Parameters|Description|
|
|
|
|-------------|-----------|----------|--------|-----------|
|
|
|
|
... | ... | |