From 3be27734c0cfa9e13acdc37e497e5a2c411db29b Mon Sep 17 00:00:00 2001
From: Brian Barrett <brbarret@open-mpi.org>
Date: Thu, 5 Aug 2004 14:35:38 +0000
Subject: [PATCH] * add Doxy comments for the init / finalize functions

This commit was SVN r1894.
---
 src/runtime/runtime.h | 66 ++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 65 insertions(+), 1 deletion(-)

diff --git a/src/runtime/runtime.h b/src/runtime/runtime.h
index 4a235d646e..fceea54c88 100644
--- a/src/runtime/runtime.h
+++ b/src/runtime/runtime.h
@@ -2,6 +2,12 @@
  * $HEADER$
  */
 
+/**
+ * @file
+ *
+ * Interface into the Open MPI Run Time Environment
+ */
+
 #ifndef OMPI_RUNTIME_H
 #define OMPI_RUNTIME_H
 
@@ -25,13 +31,71 @@ extern int ompi_mpi_thread_provided;
 extern "C" {
 #endif
 
-  int ompi_abort(int status, char *fmt, ...);
+  /**
+   * Initialize the Open MPI support code
+   *
+   * This function initializes the Open MPI support code, including
+   * malloc debugging and threads.  It should be called exactly once
+   * by every application that utilizes any of the Open MPI support
+   * libraries (including MPI applications, mpirun, and mpicc).
+   *
+   * This function should be called before \code ompi_rte_init, if
+   * \code ompi_rte_init is to be called.
+   */
   int ompi_init(int argc, char* argv[]);
+
+  /**
+   * Finalize the Open MPI support code
+   *
+   * Finalize the Open MPI support code.  Any function calling \code
+   * ompi_init should call \code ompi_finalize.  This function should
+   * be called after \code ompi_rte_finalize, if \code
+   * ompi_rte_finalize is called.
+   */
   int ompi_finalize(void);
+
+  /**
+   * Abort the current application with a pretty-print error message
+   *
+   * Aborts currently running application with \code abort(), pretty
+   * printing an error message if possible.  Error message should be
+   * specified using the standard \code printf() format.
+   */
+  int ompi_abort(int status, char *fmt, ...);
+
+
+  /**
+   * Initialize the Open MPI run time environment
+   *
+   * Initlize the Open MPI run time environment, including process
+   * control and out of band messaging.  This function should be
+   * called exactly once, after \code ompi_init.  This function should
+   * be called by every application using the RTE interface, including
+   * MPI applications and mpirun.
+   */
   int ompi_rte_init(bool *allow_multi_user_threads, bool *have_hidden_threads);
+
+  /**
+   * Finalize the Open MPI run time environment
+   *
+   */
   int ompi_rte_finalize(void);
 
+
+  /**
+   * Initialize the Open MPI MPI environment
+   *
+   * Intialize all support code needed for MPI applications.  This
+   * function should only be called by MPI applications (including
+   * singletons).  It should only be called after both \code
+   * ompi_init() and \code ompi_rte_init() have been called.
+   */
   int ompi_mpi_init(int argc, char **argv, int requested, int *provided);
+
+  /**
+   * Finalize the Open MPI MPI environment
+   *
+   */
   int ompi_mpi_finalize(void);
 
 #ifdef __cplusplus