From 49dfd6a5274d13643383cd0142405d90b562f757 Mon Sep 17 00:00:00 2001 From: Jeff Squyres Date: Wed, 3 Aug 2005 21:14:40 +0000 Subject: [PATCH] Add doxy docs for a function that was missing them. This commit was SVN r6728. --- opal/util/argv.h | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/opal/util/argv.h b/opal/util/argv.h index 414588e310..3f539e3837 100644 --- a/opal/util/argv.h +++ b/opal/util/argv.h @@ -59,6 +59,22 @@ extern "C" { * string (i.e., the arg parameter) after invoking this function. */ OMPI_DECLSPEC int opal_argv_append(int *argc, char ***argv, const char *arg); + + /** + * Append to an argv-style array, but ignore the size of the array. + * + * @param argv Pointer to an argv array. + * @param str Pointer to the string to append. + * + * @retval OMPI_SUCCESS On success + * @retval OMPI_ERROR On failure + * + * This function is identical to the opal_argv_append() function + * except that it does not take a pointer to an argc (integer + * representing the size of the array). This is handy for + * argv-style arrays that do not have integers that are actively + * maintaing their sizes. + */ OMPI_DECLSPEC int opal_argv_append_nosize(char ***argv, const char *arg); /**