From fb3d194f915e3566649570bb199f41b4f4e38c29 Mon Sep 17 00:00:00 2001 From: "Fletcher T. Penney" Date: Sun, 14 Jun 2015 10:21:11 -0400 Subject: [PATCH] Document something about doxygen --- IMPORTANT | 5 +++++ README.md | 6 ++++++ 2 files changed, 11 insertions(+) diff --git a/IMPORTANT b/IMPORTANT index a332193..a3e1bd2 100644 --- a/IMPORTANT +++ b/IMPORTANT @@ -19,6 +19,11 @@ Create an Xcode project for use on OS X. Used for cross-compiling for Windows using MinGW. + make documentation + +Setup a `doxygen` configuration file based on project information, and then +generate HTML and LaTeX documentation. + make clean Clean up the `build` directory. diff --git a/README.md b/README.md index 994a00e..a609df5 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,17 @@ Additionally, I wanted to try to start encouraging some "better practices" `cmake` to combine those elements to ensure consistency across source code and README files. +4. Documentation -- some default setup to allow for [doxygen]-generated + documentation. The generated `README.md` file is used as the main + page, and the source c/header files are included. Naturally, doxygen + is a complex system, so you're responsible for figuring out how to + properly document your code. [tdd]: https://en.wikipedia.org/wiki/Test-driven_development [cmake]: http://www.cmake.org/ [CuTest]: http://cutest.sourceforge.net +[doxygen]: http://www.stack.nl/~dimitri/doxygen/ # How do I use it? # -- 2.40.0