Skip to content

Latest commit

 

History

History
14 lines (8 loc) · 803 Bytes

documenting-code.md

File metadata and controls

14 lines (8 loc) · 803 Bytes

Documentation Guidelines

Please follow the following documentation guidelines with contributing new code to Mutation++. This helps keep the API documentation as clear and up-to-date as possible.

In general, with good naming conventions, your documentation can be minimal in implementation blocks. The only required documentation is that which describes the API, such as classes and method headers.

C++

Doxygen is used to compile the API documentation for the library. Please follow the Doxygen guidelines when commenting your code. We can extend these guidelines in the future if need be.

Python

Please follow PEP 257 when documenting python code.