Slightly improve doxygen generated documentation.

Add some links to function

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

1 files changed, 13 insertions, 12 deletions

diff --git a/include/apr_general.h b/include/apr_general.h
index 07b49f59f..4f2a6e8c4 100644
--- a/include/apr_general.h
+++ b/include/apr_general.h
@@ -183,8 +183,8 @@ struct type { \
 /**
  * Setup any APR internal data structures.  This MUST be the first function 
  * called for any APR library. It is safe to call apr_initialize several
- * times as long as apr_terminate is called the same number of times.
- * @remark See apr_app_initialize if this is an application, rather than
+ * times as long as apr_terminate() is called the same number of times.
+ * @remark See apr_app_initialize() if this is an application, rather than
  * a library consumer of apr.
  */
 APR_DECLARE(apr_status_t) apr_initialize(void);
@@ -197,9 +197,9 @@ APR_DECLARE(apr_status_t) apr_initialize(void);
  * @param argc Pointer to the argc that may be corrected
  * @param argv Pointer to the argv that may be corrected
  * @param env Pointer to the env that may be corrected, may be NULL
- * @remark See apr_initialize if this is a library consumer of apr.
- * Otherwise, this call is identical to apr_initialize, and must be closed
- * with a call to apr_terminate at the end of program execution.
+ * @remark See apr_initialize() if this is a library consumer of apr.
+ * Otherwise, this call is identical to apr_initialize(), and must be closed
+ * with a call to apr_terminate() at the end of program execution.
  */
 APR_DECLARE(apr_status_t) apr_app_initialize(int *argc, 
                                              char const * const * *argv, 
@@ -211,20 +211,21 @@ APR_DECLARE(apr_status_t) apr_app_initialize(int *argc,
  * apr_initialize() or apr_app_initialize().
  * @remark An APR program must call this function at termination once it 
  *         has stopped using APR services.  The APR developers suggest using
- *         atexit to ensure this is called.  When using APR from a language
- *         other than C that has problems with the calling convention, use
- *         apr_terminate2() instead.
+ *         @c atexit(apr_terminate) to ensure this is called.  When using APR
+ *         from a language other than C that has problems with the calling
+ *         convention, use apr_terminate2() instead.
+ * @see apr_terminate2
  */
 APR_DECLARE_NONSTD(void) apr_terminate(void);
 
 /**
  * Tear down any APR internal data structures which aren't torn down 
- * automatically, same as apr_terminate
- * @remark An APR program must call either the apr_terminate or apr_terminate2 
+ * automatically, same as apr_terminate()
+ * @remark An APR program must call either the apr_terminate() or apr_terminate2
  *         function once it it has finished using APR services.  The APR 
- *         developers suggest using atexit(apr_terminate) to ensure this is done.
+ *         developers suggest using @c atexit(apr_terminate) to ensure this is done.
  *         apr_terminate2 exists to allow non-c language apps to tear down apr, 
- *         while apr_terminate is recommended from c language applications.
+ *         while apr_terminate() is recommended from c language applications.
  */
 APR_DECLARE(void) apr_terminate2(void);