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, 38 insertions, 21 deletions

diff --git a/include/apr_dso.h b/include/apr_dso.h
index ea7ae47dc..01f71c34c 100644
--- a/include/apr_dso.h
+++ b/include/apr_dso.h
@@ -65,37 +65,54 @@ extern "C" {
 typedef struct ap_dso_handle_t        ap_dso_handle_t;
 typedef void *                        ap_dso_handle_sym_t;
 
-/* ***APRDOC********************************************************
- * ap_status_t ap_dso_init(void)
- *    Initialize the underlying DSO library.
+/*
+
+=head1 ap_status_t ap_dso_init(void)
+
+B<Initialize the underlying DSO library.>
+
+=cut
  */
 ap_status_t ap_dso_init(void);
 
-/* ***APRDOC********************************************************
- * ap_status_t ap_dso_load(ap_dso_handle_t **res_handle, const char *path,
- *                         ap_context_t *ctx)
- *    Load a DSO library.
- * arg 1) Location to store new handle for the DSO.
- * arg 2) Path to the DSO library
- * arg 3) Context to use. 
+/*
+
+=head1 ap_status_t ap_dso_load(ap_dso_handle_t **res_handle, const char *path, ap_pool_t *ctx)
+
+B<Load a DSO library.>
+
+    arg 1) Location to store new handle for the DSO.
+    arg 2) Path to the DSO library
+    arg 3) Pool to use. 
+
+=cut
  */
 ap_status_t ap_dso_load(ap_dso_handle_t **res_handle, const char *path, 
                         ap_pool_t *ctx);
 
-/* ***APRDOC********************************************************
- * ap_status_t ap_dso_unload(ap_dso_handle_t *handle)
- *    Close a DSO library.
- * arg 1) handle to close.
+/*
+
+=head1 ap_status_t ap_dso_unload(ap_dso_handle_t *handle)
+
+B<Close a DSO library.>
+
+    arg 1) handle to close.
+
+=cut
  */
 ap_status_t ap_dso_unload(ap_dso_handle_t *handle);
 
-/* ***APRDOC********************************************************
- * ap_status_t ap_dso_sym(ap_dso_handle_sym_t *ressym, ap_dso_handle_t *handle
- *                        const char *symname)
- *    Load a symbol from a DSO handle.
- * arg 1) Location to store the loaded symbol
- * arg 2) handle to load from.
- * arg 3) Name of the symbol to load.
+/*
+
+=head1 ap_status_t ap_dso_sym(ap_dso_handle_sym_t *ressym, ap_dso_handle_t *handle *, const char *symname)
+
+B<Load a symbol from a DSO handle.>
+
+    arg 1) Location to store the loaded symbol
+    arg 2) handle to load from.
+    arg 3) Name of the symbol to load.
+
+=cut
  */
 ap_status_t ap_dso_sym(ap_dso_handle_sym_t *ressym, ap_dso_handle_t *handle, 
                        const char *symname);