From 4272380e40486c61a17e84a791eee602da2eb6e3 Mon Sep 17 00:00:00 2001 From: dickelbeck Date: Thu, 30 Aug 2007 14:58:49 +0000 Subject: [PATCH] new file --- todo.txt | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 todo.txt diff --git a/todo.txt b/todo.txt new file mode 100644 index 0000000000..d027124c67 --- /dev/null +++ b/todo.txt @@ -0,0 +1,20 @@ + +Here are some source code maintenance tasks that need to be done, and maybe some +folks will see these items and volunteer to to them. + + +*** Set up a DOXYGEN environment starting with a configuration file that: +- understands the JavaDoc style comments that we have started using +- gives preference to comments in header files over *.cpp files +- outputs its HTML stuff relative to the base of trunk, say for example trunk/doxygen +- is then added to the svn repository (this configuration file only) +Then add a shell script and batch file to generate the docs using the config file. +Then review the generated docs and start to go through the source and make the +generated doxygen docs readable and clear using the JavaDoc style comments, +mostly in the header files. The error and warning output of the doxygen +compiler can help with this too. + + +*** Translate comments that are in French to English so there can be a broader +understanding by new developers. +