Code Documentation

Documentation

• Module and theme specific documentation should be documented via Doxygen comments within the files they document.

  • These comments are compiled into documentation reference files which can be found at http://dosomething.github.io/dosomething/files.html.
    • Compilation happens through the Doxygen job on Jenkins, which is in turn triggered by the Pull job after every commit to the dev branch.

• Internal infrastructure, such as info about our QA or production environment, should be documented in the DoSomething Tech Wiki.

• Some pull requests are worth remembering.