Commit Graph
2 Commits
Author SHA1 Message Date
Jan de Muijnck-Hughes 5a753ba908 Added api documentation.
The outward facing api has been documented where possible. If the
documentation has not been added a `@todo` annotations has been
added. Doxygen will constuct a list of TODO's automatically.
2013-12-08 15:58:03 +00:00
Jan de Muijnck-Hughes e1218882d4 Initial commit for contribution of documentation.
+ Updated `.gitignore`
+ Added `Doxyfile`.

[Doxygen](http://www.doxygen.org) has been setup to look for documented `C` fles within:

+ `src/sodium/includes`; and
+ `test`

When run with the Doxygen tool documentation will be generated within
the directory `doxydoc`. The projects README.markdown file is used at
the documentation's main page.

More information on Doxygen tags and abilities can be found on the
projects website: http://www.doxygen.org
2013-12-08 14:46:19 +00:00