readme-devel-doxygen-20080713
authorRuss Allbery <rra@stanford.edu>
Mon, 14 Jul 2008 06:53:14 +0000 (06:53 +0000)
committerRuss Allbery <rra@stanford.edu>
Mon, 14 Jul 2008 06:53:14 +0000 (06:53 +0000)
LICENSE IPL10

Document the preferred Doxygen comment style.

README.DEVEL

index af83ca3..3c3d2b9 100644 (file)
@@ -70,6 +70,9 @@ Compiles on gcc-using machines should strive to handle using
 Routines shall be defined in source prior to use if possible, and 
 prototyped in block at top of file if static.
 
+API documentation in the code should be done using Qt-style Doxygen
+comments.
+
 If you make a routine or variable static, be sure and remove it from
 the AIX .exp files.