STABLE14-readme-devel-doxygen-20080713

LICENSE IPL10

Document the preferred Doxygen comment style.

(cherry picked from commit faeb953142a15866f0a35e908114a2443f0ac703)

diff --git a/README.DEVEL b/README.DEVEL
index ea5dfcbbc28880489c4fd000d81692f66f62d857..95f97a147c92cb7261ceff4abc9c1dc22f54a776 100644 (file)
--- a/README.DEVEL
+++ b/README.DEVEL
@@ -68,6 +68,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.