[Roadmap-commit] roadmap/doc Coding,1.2,1.3

[Paul F. <pg...@us...>]

Update of /cvsroot/roadmap/roadmap/doc
In directory 23jxhf1.ch3.sourceforge.com:/tmp/cvs-serv27815

Modified Files:
	Coding 
Log Message:
add doxygen note


Index: Coding
===================================================================
RCS file: /cvsroot/roadmap/roadmap/doc/Coding,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** Coding	27 Jan 2009 01:42:13 -0000	1.2
--- Coding	27 Jan 2009 02:39:58 -0000	1.3
***************
*** 5,8 ****
--- 5,19 ----
  = Developer Information =
  
+   - Doxygen
+ 
+      Some, but nowhere near all, of the RoadMap codebase has been
+      annotated with doxygen-compatible markup.  Running "make apidocs"
+      in the "src" directory will result in a "doc/api/html" subdirectory
+      containing the doxygen-generated output.  It's best to run this
+      is a fairly clean source tree, because currently the doxygen
+      configuration examines all source files, whether or not they're
+      really part of RoadMap (e.g., old debug files, or test harnesses,
+      will be examined and "documented" as well.
+ 
    - Porting RoadMap