Change the format for APR function documentation. This uses the perldoc

scripts to generate either plain text, html, or any other format perldoc
can generate.  This also fixes the comments to say ap_pool instead of
ap_context.


git-svn-id: http://svn.apache.org/repos/asf/apr/apr/trunk@59869 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 17 insertions, 8 deletions

diff --git a/APRDesign b/APRDesign
index fe5109a3a..acca89c85 100644
--- a/APRDesign
+++ b/APRDesign
@@ -168,16 +168,25 @@ above the prototypes to be checked into the unix tree.
 
 The format for the comment block is:
 
-/* ***APRDOC********************************************************
- * Function prototype with variable names
- *    A one or two line description of what the function does.
- * arg 1) A brief description of the first argument.
- * ...
- * arg N) A brief description of the Nth argument.
- * NOTE:  This is optional.  If there is anything programmers need to
- *        know about your function, add it here. 
+/*
+
+=head1 function prototype
+
+B<Brief description of function>
+
+    arg 1)  explanation of arg 1
+    arg 2)  explanation of arg 2
+    arg N)  explanation of arg N
+
+B<NOTE>:  Any extra information the programmer needs.
+
+=cut
  */                                                                             
 
+The spacing for the documentation is VERY important, because the docs are
+processed with perldoc, and this spacing is required for the perldoc scripts
+to work properly.
+
 For an actual example, look at any function in the fileio/unix directory.
 
 APR Error reporting