From: Russ Allbery <rra@stanford.edu>
Date: Mon, 14 Jul 2008 07:03:17 +0000 (+0000)
Subject: STABLE14-readme-devel-doxygen-20080713
X-Git-Tag: openafs-stable-1_4_8pre1~41
X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=111924596c45995e19d1c3116e880fdb52469d33;p=packages%2Fo%2Fopenafs.git

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 ea5dfcbbc..95f97a147 100644
--- 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.