[globus-gram-protocol] Fix doxygen markup
Mattias Ellert
ellert at fedoraproject.org
Tue Jun 7 14:43:56 UTC 2011
commit 2d847ff47ba220f93e71aff60035bf5c7ee90017
Author: Mattias Ellert <mattias.ellert at fysast.uu.se>
Date: Mon Jun 6 15:37:28 2011 +0200
Fix doxygen markup
globus-gram-protocol-doxygen.patch | 759 ++++++++++++++++++++++++++++++++++++
globus-gram-protocol.spec | 9 +-
2 files changed, 767 insertions(+), 1 deletions(-)
---
diff --git a/globus-gram-protocol-doxygen.patch b/globus-gram-protocol-doxygen.patch
new file mode 100644
index 0000000..748482a
--- /dev/null
+++ b/globus-gram-protocol-doxygen.patch
@@ -0,0 +1,759 @@
+diff -ur globus_gram_protocol-9.7.orig/globus_gram_protocol.c globus_gram_protocol-9.7/globus_gram_protocol.c
+--- globus_gram_protocol-9.7.orig/globus_gram_protocol.c 2010-01-20 14:41:21.000000000 +0100
++++ globus_gram_protocol-9.7/globus_gram_protocol.c 2011-06-05 11:31:59.565903428 +0200
+@@ -183,7 +183,7 @@
+ * @ingroup globus_gram_protocol_io
+ *
+ * @details
+- * The @a globus_gram_protocol_setup_attr() function creates a new
++ * The globus_gram_protocol_setup_attr() function creates a new
+ * globus_io attribute containing the default set of values needed for
+ * communication between a GRAM client and a job manager. These attributes
+ * include:
+@@ -275,7 +275,7 @@
+ * @ingroup globus_gram_protocol_io
+ *
+ * @details
+- * The @a globus_gram_protocol_authorize_self() function implements a predicate
++ * The globus_gram_protocol_authorize_self() function implements a predicate
+ * which returns true if the source and destination identities used to
+ * establish the GSSAPI security context are the same.
+ *
+diff -ur globus_gram_protocol-9.7.orig/globus_gram_protocol_error.c globus_gram_protocol-9.7/globus_gram_protocol_error.c
+--- globus_gram_protocol-9.7.orig/globus_gram_protocol_error.c 2010-02-09 21:21:37.000000000 +0100
++++ globus_gram_protocol-9.7/globus_gram_protocol_error.c 2011-06-05 11:31:59.565903428 +0200
+@@ -213,7 +213,7 @@
+ * @ingroup globus_gram_protocol_error_messages
+ *
+ * @details
+- * The @a globus_gram_protocol_error_string() function takes a GRAM error code
++ * The globus_gram_protocol_error_string() function takes a GRAM error code
+ * value and returns the associated error code string for the message. The
+ * string is statically allocated by the GRAM Protocol
+ * library and should not be modified or freed by the caller. The string is
+@@ -224,7 +224,7 @@
+ * The error code to translate into a string.
+ *
+ * @return
+- * The @a globus_gram_protocol_error_string() function returns a static
++ * The globus_gram_protocol_error_string() function returns a static
+ * string containing an explanation of the error.
+ */
+ const char *
+@@ -260,11 +260,11 @@
+ * @ingroup globus_gram_protocol_error_messages
+ *
+ * @details
+- * The @a globus_gram_protocol_error_7_hack_replace_message() function creates
++ * The globus_gram_protocol_error_7_hack_replace_message() function creates
+ * a custom version of the error message for the error
+ * @a GLOBUS_GRAM_PROTOCOL_ERROR_AUTHORIZATION. The string pointed to by the
+ * @a message parameter is copied to thread-local storage, and subsequent calls
+- * to @a globus_gram_protocol_error_string() with this error number will return
++ * to globus_gram_protocol_error_string() with this error number will return
+ * this copy of the string. Each time
+ * globus_gram_protocol_error_7_hack_replace_message() is called for
+ * a particular thread, the previous message is freed.
+@@ -283,7 +283,7 @@
+ * the value returned by globus_gram_protocol_error_string() for
+ * GLOBUS_GRAM_PROTOCOL_ERROR_AUTHORIZATION is that for the last
+ * authorization error where
+- * @a globus_gram_protocol_error_7_hack_replace_message() was called from
++ * globus_gram_protocol_error_7_hack_replace_message() was called from
+ * this thread.
+ */
+ void
+@@ -298,11 +298,11 @@
+ * @ingroup globus_gram_protocol_error_messages
+ *
+ * @details
+- * The @a globus_gram_protocol_error_10_hack_replace_message() function creates
++ * The globus_gram_protocol_error_10_hack_replace_message() function creates
+ * a custom version of the error message for the error
+ * @a GLOBUS_GRAM_PROTOCOL_ERROR_PROTOCOL_FAILED. The string pointed to by the
+ * @a message parameter is copied to thread-local storage, and subsequent calls
+- * to @a globus_gram_protocol_error_string() with this error number will return
++ * to globus_gram_protocol_error_string() with this error number will return
+ * this copy of the string. Each time
+ * globus_gram_protocol_error_10_hack_replace_message() is called for
+ * a particular thread, the previous message is freed.
+@@ -321,7 +321,7 @@
+ * the value returned by globus_gram_protocol_error_string() for
+ * GLOBUS_GRAM_PROTOCOL_ERROR_PROTOCOL_FAILED is that for the last
+ * authorization error where
+- * @a globus_gram_protocol_error_10_hack_replace_message() was called from
++ * globus_gram_protocol_error_10_hack_replace_message() was called from
+ * this thread.
+ */
+ void
+diff -ur globus_gram_protocol-9.7.orig/globus_gram_protocol_frame.c globus_gram_protocol-9.7/globus_gram_protocol_frame.c
+--- globus_gram_protocol-9.7.orig/globus_gram_protocol_frame.c 2009-11-16 21:51:37.000000000 +0100
++++ globus_gram_protocol-9.7/globus_gram_protocol_frame.c 2011-06-05 11:31:59.566903414 +0200
+@@ -46,7 +46,7 @@
+ * @ingroup globus_gram_protocol_framing
+ *
+ * @details
+- * The @a globus_gram_protocol_frame_request() function adds HTTP 1.1
++ * The globus_gram_protocol_frame_request() function adds HTTP 1.1
+ * framing around the input message. The framed message includes HTTP headers
+ * relating the the destination URL and the length of the message content.
+ * The framed message is returned by modifying @a framedmsg to point to a
+@@ -69,7 +69,7 @@
+ * framed message.
+ *
+ * @return
+- * Upon success, @a globus_gram_protocol_frame_request() will return
++ * Upon success, globus_gram_protocol_frame_request() will return
+ * GLOBUS_SUCCESS and the @a framedmsg and @a framedsize parameters will be
+ * modified to point to the new framed message string and its length
+ * respectively. When this occurs, the caller is responsible for freeing
+@@ -179,7 +179,7 @@
+ * @ingroup globus_gram_protocol_framing
+ *
+ * @details
+- * The @a globus_gram_protocol_frame_reply() function adds HTTP 1.1
++ * The globus_gram_protocol_frame_reply() function adds HTTP 1.1
+ * framing around the input message. The framed message includes HTTP headers
+ * relating the the status of the operation being replied to and the length of
+ * the message content. The framed message is returned by modifying
+@@ -201,7 +201,7 @@
+ * framed reply string pointed to by @a framedmsg.
+ *
+ * @return
+- * Upon success, @a globus_gram_protocol_frame_reply() will return
++ * Upon success, globus_gram_protocol_frame_reply() will return
+ * GLOBUS_SUCCESS and the @a framedmsg and @a framedsize parameters will be
+ * modified to point to the new framed message string and its length
+ * respectively. When this occurs, the caller is responsible for freeing
+diff -ur globus_gram_protocol-9.7.orig/globus_gram_protocol_io.c globus_gram_protocol-9.7/globus_gram_protocol_io.c
+--- globus_gram_protocol-9.7.orig/globus_gram_protocol_io.c 2010-01-20 14:41:21.000000000 +0100
++++ globus_gram_protocol-9.7/globus_gram_protocol_io.c 2011-06-05 11:31:59.568903388 +0200
+@@ -206,13 +206,13 @@
+ * @ingroup globus_gram_protocol_io
+ *
+ * @details
+- * The @a globus_gram_protocol_allow_attach() function creates a
++ * The globus_gram_protocol_allow_attach() function creates a
+ * GRAM protocol listener to which other processes can send GRAM protocol
+ * messages. The listener will automatically accept new connections on it's
+ * TCP/IP port and parse GRAM requests. The requests will be passed to the
+ * function pointed to by the @a callback parameter for the
+ * application to unpack, handle, and send a reply by calling
+- * @a globus_gram_protocol_reply().
++ * globus_gram_protocol_reply().
+ *
+ * @param url
+ * An output parameter that will be initialized to point to a string
+@@ -231,7 +231,7 @@
+ * function as its first parameter.
+ *
+ * @return
+- * Upon success, @a globus_gram_protocol_allow_attach() returns
++ * Upon success, globus_gram_protocol_allow_attach() returns
+ * @a GLOBUS_SUCCESS and modifies the @a url parameter to point to a newly
+ * allocated string. The caller is then responsible for freeing this
+ * string. If an error occurs, an integer error code will be returned and
+@@ -362,21 +362,21 @@
+ * @ingroup globus_gram_protocol_io
+ *
+ * @details
+- * The @a globus_gram_protocol_callback_disallow() function stops the
++ * The globus_gram_protocol_callback_disallow() function stops the
+ * listener named by the value of the @a url parameter from receiving any
+ * new requests. It also frees memory used internally by the GRAM protocol
+ * implementation to handle requests for this listener.
+ *
+- * The @a globus_gram_protocol_callback_disallow() function will wait until
++ * The globus_gram_protocol_callback_disallow() function will wait until
+ * all requests being processed by this listener have completed processing.
+- * Once @a globus_gram_protocol_callback_disallow() returns, no further
++ * Once globus_gram_protocol_callback_disallow() returns, no further
+ * request callbacks will occur for the listener.
+ *
+ * @param url
+ * A pointer to the URL string which names the listener to disable.
+ *
+ * @return
+- * Upon success, the @a globus_gram_protocol_callback_disallow() function
++ * Upon success, the globus_gram_protocol_callback_disallow() function
+ * returns @a GLOBUS_SUCCESS and frees internal state associated with the
+ * listener named by the @a url parameter. If an error occurs, its integer
+ * error code value will be returned and no listener will be affected.
+@@ -454,12 +454,12 @@
+ * @ingroup globus_gram_protocol_io
+ *
+ * @details
+- * The @a globus_gram_protocol_post() function initiates a GRAM protocol
++ * The globus_gram_protocol_post() function initiates a GRAM protocol
+ * message exchange with a GRAM protocol listener. It returns after framing
+ * the message and initiating the connection. When the message exchange is
+ * complete, the function pointed to by @a callback is invoked either in
+ * another thread or when a non-threaded application calls the
+- * @a globus_poll() or @a globus_cond_wait() functions.
++ * globus_poll() or globus_cond_wait() functions.
+ *
+ * @param url
+ * A pointer to a string containing the URL of the server to post the
+@@ -500,7 +500,7 @@
+ * the pointer to establish its context in the callback.
+ *
+ * @return
+- * Upon success, @a globus_gram_protocol_post() returns GLOBUS_SUCCESS,
++ * Upon success, globus_gram_protocol_post() returns GLOBUS_SUCCESS,
+ * initiates the message exchange, registers the function pointed to by
+ * @a callback to be called when the exchange completes or fails, and
+ * modifies the @a handle parameter if it is non-NULL. If an
+@@ -521,7 +521,7 @@
+ *
+ * @note
+ * There is no way to time out or cancel a service request that is
+- * begun with @a globus_gram_protocol_post().
++ * begun with globus_gram_protocol_post().
+ *
+ * @see globus_gram_protocol_reply()
+ */
+@@ -558,15 +558,15 @@
+ * @ingroup globus_gram_protocol_io
+ *
+ * @details
+- * The @a globus_gram_protocol_post_delegation() function initiates a GRAM
++ * The globus_gram_protocol_post_delegation() function initiates a GRAM
+ * protocol delegation exchange with a GRAM protocol listener. The delegation
+ * protocol is a custom mix of HTTP and SSL records.
+ *
+- * The @a globus_gram_protocol_post_delegation() function returns after framing
++ * The globus_gram_protocol_post_delegation() function returns after framing
+ * the message and initiating the connection to be used for delegation. When
+ * the message exchange is complete, the function pointed to by @a callback is
+ * invoked either in another thread or when a non-threaded application calls
+- * the @a globus_poll() or @a globus_cond_wait() functions.
++ * the globus_poll() or globus_cond_wait() functions.
+ *
+ * @param url
+ * A pointer to a string containing the URL of the server to post the
+@@ -612,7 +612,7 @@
+ * added to the credential.
+ * @param req_flags
+ * A bitwise-or of GSSAPI flag values to use when delegating the
+- * credential using @a gss_init_delegation().
++ * credential using gss_init_delegation().
+ * @param time_req
+ * An integer value indicating the length of time (in seconds) that the
+ * delegated credential should be valid for. This is an advisory parameter:
+@@ -630,7 +630,7 @@
+ * the pointer to establish its context in the callback.
+ *
+ * @return
+- * Upon success, @a globus_gram_protocol_post_delegation() returns
++ * Upon success, globus_gram_protocol_post_delegation() returns
+ * GLOBUS_SUCCESS, initiates the message exchange, registers the function
+ * pointed to by @a callback to be called when the exchange completes or
+ * fails, and modifies the @a handle parameter if it is non-NULL. If an
+@@ -653,7 +653,7 @@
+ *
+ * @note
+ * There is no way to time out or cancel a service request that is
+- * begun with @a globus_gram_protocol_post_delegation().
++ * begun with globus_gram_protocol_post_delegation().
+ *
+ * @see globus_gram_protocol_reply()
+ */
+@@ -760,12 +760,12 @@
+ * @ingroup globus_gram_protocol_io
+ *
+ * @details
+- * The @a globus_gram_protocol_accept_delegation() function performs the
++ * The globus_gram_protocol_accept_delegation() function performs the
+ * service side accepting of a GRAM protocol delegation exchange with a GRAM
+ * protocol client. This is performed after the delegation HTTP message has
+ * been unpacked by the application.
+ *
+- * The @a globus_gram_protocol_accept_delegation() function returns after
++ * The globus_gram_protocol_accept_delegation() function returns after
+ * processing the GSSAPI handshake, passing the delegated credential or
+ * error information to the function pointed to by the @a callback parameter.
+ *
+@@ -784,7 +784,7 @@
+ * added to the credential.
+ * @param req_flags
+ * A bitwise-or of GSSAPI flag values to use when delegating the
+- * credential using @a gss_init_delegation().
++ * credential using gss_init_delegation().
+ * @param time_req
+ * An integer value indicating the length of time (in seconds) that the
+ * delegated credential should be valid for. This is an advisory parameter:
+@@ -802,10 +802,10 @@
+ * the pointer to establish its context in the callback.
+ *
+ * @return
+- * Upon success, @a globus_gram_protocol_accept_delegation() returns
++ * Upon success, globus_gram_protocol_accept_delegation() returns
+ * GLOBUS_SUCCESS and registers the function pointed to by @a callback
+ * to be called after the delegation completes or fails. If an error
+- * occurs, @a globus_gram_protocol_accept_delegation() returns an integer
++ * occurs, globus_gram_protocol_accept_delegation() returns an integer
+ * error code and the @a callback function is not registered.
+ *
+ * @retval GLOBUS_SUCCESS
+@@ -2030,19 +2030,19 @@
+ * @brief Set GRAM default credential
+ * @ingroup globus_gram_protocol_io
+ * @details
+- * The @a globus_gram_protocol_set_credentials() function causes subsequent
++ * The globus_gram_protocol_set_credentials() function causes subsequent
+ * GRAM operations to use the GSSAPI credential @a new_credentials. After this
+ * function returns, the caller must not use the credential, as it may be freed
+ * by GRAM when it is no longer needed.
+ *
+- * As a side effect, @a globus_gram_protocol_set_credentials() may free any
++ * As a side effect, globus_gram_protocol_set_credentials() may free any
+ * credential previously used by GRAM.
+ *
+ * @param new_credentials
+ * New GSSAPI credential to use.
+ *
+ * @return
+- * Upon success, @a globus_gram_protocol_set_credentials() returns
++ * Upon success, globus_gram_protocol_set_credentials() returns
+ * GLOBUS_SUCCESS. There are currently no error cases handled by this
+ * function.
+ *
+diff -ur globus_gram_protocol-9.7.orig/globus_gram_protocol_pack.c globus_gram_protocol-9.7/globus_gram_protocol_pack.c
+--- globus_gram_protocol-9.7.orig/globus_gram_protocol_pack.c 2010-02-16 22:08:10.000000000 +0100
++++ globus_gram_protocol-9.7/globus_gram_protocol_pack.c 2011-06-05 11:33:05.438024657 +0200
+@@ -66,10 +66,10 @@
+ * @ingroup globus_gram_protocol_pack
+ *
+ * @details
+- * The @a globus_gram_protocol_pack_job_request() function combines its
++ * The globus_gram_protocol_pack_job_request() function combines its
+ * parameters into a GRAM job request message body. The caller may frame
+- * and send the resulting message by calling @a globus_gram_protocol_post()
+- * or just frame it by calling @a globus_gram_protocol_frame_request() and send
++ * and send the resulting message by calling globus_gram_protocol_post()
++ * or just frame it by calling globus_gram_protocol_frame_request() and send
+ * it by some other mechanism. The globus_gram_protocol_pack_job_request()
+ * function returns the packed message by modifying the @a query parameter to
+ * point to a new string containing the message. The caller is responsible for
+@@ -84,7 +84,7 @@
+ * This may be NULL, if the client does not wish to register
+ * a callback contact with this job request. Typically, this value
+ * is returned in the @a url parameter to
+- * @a globus_gram_protocol_allow_attach().
++ * globus_gram_protocol_allow_attach().
+ * @param rsl
+ * An RSL string which contains the job request. This will
+ * be processed on the server side.
+@@ -97,7 +97,7 @@
+ * of the job request message returned in @a query.
+ *
+ * @return
+- * Upon success, @a globus_gram_protocol_pack_job_request() returns
++ * Upon success, globus_gram_protocol_pack_job_request() returns
+ * GLOBUS_SUCCESS and modifies the @a query and @a querysize parameters to
+ * point to the values described above.
+ *
+@@ -153,7 +153,7 @@
+ * @ingroup globus_gram_protocol_unpack
+ *
+ * @details
+- * The @a globus_gram_protocol_unpack_job_request() function parses the
++ * The globus_gram_protocol_unpack_job_request() function parses the
+ * job request message packed in the @a query message and returns copies of
+ * the standard message attributes in the @a job_state_mask, @a callback_url,
+ * and @a description parameters.
+@@ -175,7 +175,7 @@
+ * free this memory by calling free().
+ *
+ * @return
+- * Upon success, @a globus_gram_protocol_unpack_job_request() will
++ * Upon success, globus_gram_protocol_unpack_job_request() will
+ * return @a GLOBUS_SUCCESS and modify the @a job_state_mask,
+ * @a callback_url, and @a description parameters to values extracted
+ * from the message in @a query. If an error occurs, an integer error code
+@@ -294,12 +294,12 @@
+ * @ingroup globus_gram_protocol_pack
+ *
+ * @details
+- * The @a globus_gram_protocol_pack_job_request_reply() function combines its
++ * The globus_gram_protocol_pack_job_request_reply() function combines its
+ * parameters into a GRAM reply message body. The caller may frame
+- * and send the resulting message by calling @a globus_gram_protocol_reply()
+- * or just frame it by calling @a globus_gram_protocol_frame_reply() and send
++ * and send the resulting message by calling globus_gram_protocol_reply()
++ * or just frame it by calling globus_gram_protocol_frame_reply() and send
+ * it by some other mechanism. The
+- * @a globus_gram_protocol_pack_job_request_reply()
++ * globus_gram_protocol_pack_job_request_reply()
+ * function returns the packed message by modifying the @a reply parameter to
+ * point to a new string containing the message. The caller is responsible for
+ * freeing that string.
+@@ -317,7 +317,7 @@
+ * A pointer which will be set to the length of the reply string.
+ *
+ * @return
+- * Upon success, @a globus_gram_protocol_pack_job_request_reply() returns
++ * Upon success, globus_gram_protocol_pack_job_request_reply() returns
+ * @a GLOBUS_SUCCESS and modifies the @a reply and @a replysize parameters
+ * to point to the values described above. If an error occurs, an integer
+ * error code is returned and the values pointed to by @a reply and
+@@ -370,7 +370,7 @@
+ * @ingroup globus_gram_protocol_unpack
+ *
+ * @details
+- * The @a globus_gram_protocol_unpack_job_request_reply() function parses the
++ * The globus_gram_protocol_unpack_job_request_reply() function parses the
+ * reply message packed in the @a reply message and returns copies of
+ * the standard message attributes in the @a status and @a job_contact
+ * parameters.
+@@ -385,12 +385,12 @@
+ * if the job request was successful.
+ * @param job_contact
+ * A pointer to a string to be set to the job contact string. This may set
+- * to NULL if the job request failed. If @a
++ * to NULL if the job request failed. If
+ * globus_gram_protocol_unpack_job_request_reply() returns GLOBUS_SUCCESS,
+ * then the caller must free this string using free().
+ *
+ * @return
+- * Upon success, @a globus_gram_protocol_unpack_job_request_reply() returns
++ * Upon success, globus_gram_protocol_unpack_job_request_reply() returns
+ * @a GLOBUS_SUCCESS and modifies the @a status and @a job_contact
+ * parameters to point to the values described above. If an error occurs,
+ * an integer error code is returned and the values pointed to by @a status
+@@ -485,12 +485,12 @@
+ * @ingroup globus_gram_protocol_pack
+ *
+ * @details
+- * The @a globus_gram_protocol_pack_job_request_reply_with_extensions()
++ * The globus_gram_protocol_pack_job_request_reply_with_extensions()
+ * function combines its parameters into a GRAM reply message body. The
+ * caller may frame and send the resulting message by calling
+- * @a globus_gram_protocol_reply() or just frame it by calling
+- * @a globus_gram_protocol_frame_reply() and send it by some other mechanism.
+- * The @a globus_gram_protocol_pack_job_request_reply_with_extensions()
++ * globus_gram_protocol_reply() or just frame it by calling
++ * globus_gram_protocol_frame_reply() and send it by some other mechanism.
++ * The globus_gram_protocol_pack_job_request_reply_with_extensions()
+ * function returns the packed message by modifying the @a reply parameter to
+ * point to a new string containing the message. The caller is responsible for
+ * freeing that string.
+@@ -514,7 +514,7 @@
+ *
+ * @return
+ * Upon success,
+- * @a globus_gram_protocol_pack_job_request_reply_with_extensions() returns
++ * globus_gram_protocol_pack_job_request_reply_with_extensions() returns
+ * @a GLOBUS_SUCCESS and modifies the @a reply and @a replysize parameters
+ * to point to the values described above. If an error occurs, an integer
+ * error code is returned and the values pointed to by @a reply and
+@@ -631,7 +631,7 @@
+ * @ingroup globus_gram_protocol_unpack
+ *
+ * @details
+- * The @a globus_gram_protocol_unpack_job_request_reply_with_extensions()
++ * The globus_gram_protocol_unpack_job_request_reply_with_extensions()
+ * function parses the reply message packed in the @a reply message parameter
+ * and returns copies of the standard message attributes in the @a status and
+ * @a job_contact parameters, and all other extension attributes in the
+@@ -645,14 +645,14 @@
+ * if the job request was successful.
+ * @param job_contact
+ * A pointer to a string to be set to the job contact string. This may set
+- * to NULL if the job request failed. If @a
++ * to NULL if the job request failed. If
+ * globus_gram_protocol_unpack_job_request_reply_with_extensions() returns
+ * GLOBUS_SUCCESS, then the caller must free this string using free().
+ * @param extensions
+ * A pointer to be set to a hash table containing the
+ * names and values of all protocol extensions present in the response
+ * message. If
+- * @a globus_gram_protocol_unpack_job_request_reply_with_extensions()
++ * globus_gram_protocol_unpack_job_request_reply_with_extensions()
+ * returns GLOBUS_SUCCESS, the caller must free this hash table and its
+ * values by calling globus_gram_protocol_hash_destroy().
+ * @param reply
+@@ -662,7 +662,7 @@
+ *
+ * @return
+ * Upon success,
+- * @a globus_gram_protocol_unpack_job_request_reply_with_extensions()
++ * globus_gram_protocol_unpack_job_request_reply_with_extensions()
+ * returns @a GLOBUS_SUCCESS and modifies the @a status, @a job_contact,
+ * and @a extensions to point to the values described above. If an error
+ * occurs, an integer error code is returned and the values pointed to by
+@@ -775,12 +775,12 @@
+ * @ingroup globus_gram_protocol_pack
+ *
+ * @details
+- * The @a globus_gram_protocol_pack_status_request()
++ * The globus_gram_protocol_pack_status_request()
+ * function combines its parameters into a GRAM status query message body. The
+ * caller may frame and send the resulting message by calling
+- * @a globus_gram_protocol_post() or just frame it by calling
+- * @a globus_gram_protocol_frame_request() and send it by some other mechanism.
+- * The @a globus_gram_protocol_pack_status_request()
++ * globus_gram_protocol_post() or just frame it by calling
++ * globus_gram_protocol_frame_request() and send it by some other mechanism.
++ * The globus_gram_protocol_pack_status_request()
+ * function returns the packed message by modifying the @a query parameter to
+ * point to a new string containing the message. The caller is responsible for
+ * freeing that string.
+@@ -803,7 +803,7 @@
+ *
+ * @return
+ * Upon success,
+- * @a globus_gram_protocol_pack_status_request() returns
++ * globus_gram_protocol_pack_status_request() returns
+ * @a GLOBUS_SUCCESS and modifies the @a query and @a querysize parameters
+ * to point to the values described above. If an error occurs, an integer
+ * error code is returned and the values pointed to by @a query and
+@@ -851,7 +851,7 @@
+ * @ingroup globus_gram_protocol_unpack
+ *
+ * @details
+- * The @a globus_gram_protocol_unpack_status_request()
++ * The globus_gram_protocol_unpack_status_request()
+ * function parses the message packed in the @a query parameter
+ * and returns a copy of the message in the @a status_request parameter.
+ *
+@@ -865,7 +865,7 @@
+ *
+ * @return
+ * Upon success,
+- * @a globus_gram_protocol_unpack_status_request() returns
++ * globus_gram_protocol_unpack_status_request() returns
+ * @a GLOBUS_SUCCESS and modifies the @a status_request parameter
+ * to point to the value described above. If an error occurs, an integer
+ * error code is returned and the value pointed to by @a status_request
+@@ -955,12 +955,12 @@
+ * @ingroup globus_gram_protocol_pack
+ *
+ * @details
+- * The @a globus_gram_protocol_pack_status_reply()
++ * The globus_gram_protocol_pack_status_reply()
+ * function combines its parameters into a GRAM status reply message body. The
+ * caller may frame and send the resulting message by calling
+- * @a globus_gram_protocol_reply() or just frame it by calling
+- * @a globus_gram_protocol_frame_reply() and send it by some other mechanism.
+- * The @a globus_gram_protocol_pack_status_reply()
++ * globus_gram_protocol_reply() or just frame it by calling
++ * globus_gram_protocol_frame_reply() and send it by some other mechanism.
++ * The globus_gram_protocol_pack_status_reply()
+ * function returns the packed message by modifying the @a reply parameter to
+ * point to a new string containing the message. The caller is responsible for
+ * freeing that string.
+@@ -983,7 +983,7 @@
+ *
+ * @return
+ * Upon success,
+- * @a globus_gram_protocol_pack_status_reply() returns
++ * globus_gram_protocol_pack_status_reply() returns
+ * @a GLOBUS_SUCCESS and modifies the @a reply and @a replysize parameters
+ * to point to the values described above. If an error occurs, an integer
+ * error code is returned and the values pointed to by @a reply and
+@@ -1033,7 +1033,7 @@
+ * @brief Unpack a GRAM query reply
+ * @ingroup globus_gram_protocol_unpack
+ * @details
+- * The @a globus_gram_protocol_unpack_status_reply()
++ * The globus_gram_protocol_unpack_status_reply()
+ * function parses the message packed in the @a reply parameter
+ * and sets the current job state, protocol failure code, and job failure code
+ * values in its output parameters.
+@@ -1055,7 +1055,7 @@
+ * GLOBUS_GRAM_PROTOCOL_JOB_STATE_FAILED.
+ *
+ * @return
+- * Upon success, @a globus_gram_protocol_unpack_status_reply() returns
++ * Upon success, globus_gram_protocol_unpack_status_reply() returns
+ * @a GLOBUS_SUCCESS and modifies the @a job_status, @a failure_code,
+ * and @a job_failure_code parameters to point to the value described
+ * above. If an error occurs, an integer error code is returned and the
+@@ -1124,12 +1124,12 @@
+ * @ingroup globus_gram_protocol_pack
+ *
+ * @details
+- * The @a globus_gram_protocol_pack_status_reply_with_extensions()
++ * The globus_gram_protocol_pack_status_reply_with_extensions()
+ * function combines its parameters into a GRAM status reply message body. The
+ * caller may frame and send the resulting message by calling
+- * @a globus_gram_protocol_reply() or just frame it by calling
+- * @a globus_gram_protocol_frame_reply() and send it by some other mechanism.
+- * The @a globus_gram_protocol_pack_status_reply_with_extensions()
++ * globus_gram_protocol_reply() or just frame it by calling
++ * globus_gram_protocol_frame_reply() and send it by some other mechanism.
++ * The globus_gram_protocol_pack_status_reply_with_extensions()
+ * function returns the packed message by modifying the @a reply parameter to
+ * point to a new string containing the message. The caller is responsible for
+ * freeing that string.
+@@ -1155,7 +1155,7 @@
+ *
+ * @return
+ * Upon success,
+- * @a globus_gram_protocol_pack_status_reply_with_extensions() returns
++ * globus_gram_protocol_pack_status_reply_with_extensions() returns
+ * @a GLOBUS_SUCCESS and modifies the @a reply and @a replysize parameters
+ * to point to the values described above. If an error occurs, an integer
+ * error code is returned and the values pointed to by @a reply and
+@@ -1260,12 +1260,12 @@
+ * @brief Unpack a GRAM query reply with extensions
+ * @ingroup globus_gram_protocol_unpack
+ * @details
+- * The @a globus_gram_protocol_unpack_status_reply_with_extensions()
++ * The globus_gram_protocol_unpack_status_reply_with_extensions()
+ * function parses the message packed in the @a reply parameter,
+ * storing all attributes and values in a hash table. The @a extensions
+ * parameter is modified to point to that hash table. The caller of
+- * @a globus_gram_protocol_unpack_status_reply_with_extensions() must
+- * free that hash table by calling @a globus_gram_protocol_hash_destroy().
++ * globus_gram_protocol_unpack_status_reply_with_extensions() must
++ * free that hash table by calling globus_gram_protocol_hash_destroy().
+ *
+ * @param reply
+ * The unframed reply message to parse.
+@@ -1275,13 +1275,13 @@
+ * A pointer to be set to a hash table containing the
+ * names and values of all protocol attributes present in the reply
+ * message. If
+- * @a globus_gram_protocol_unpack_status_reply_with_extensions()
++ * globus_gram_protocol_unpack_status_reply_with_extensions()
+ * returns GLOBUS_SUCCESS, the caller must free this hash table and its
+ * values by calling globus_gram_protocol_hash_destroy().
+ *
+ * @return
+ * Upon success,
+- * @a globus_gram_protocol_unpack_status_reply_with_extensions() returns
++ * globus_gram_protocol_unpack_status_reply_with_extensions() returns
+ * @a GLOBUS_SUCCESS and modifies the @a extensions
+ * parameter to point to the value described
+ * above. If an error occurs, an integer error code is returned and the
+@@ -1387,12 +1387,12 @@
+ * @ingroup globus_gram_protocol_pack
+ *
+ * @details
+- * The @a globus_gram_protocol_pack_status_update_message()
++ * The globus_gram_protocol_pack_status_update_message()
+ * function combines its parameters into a GRAM status update message body. The
+ * caller may frame and send the resulting message by calling
+- * @a globus_gram_protocol_post() or just frame it by calling
+- * @a globus_gram_protocol_frame_request() and send it by some other mechanism.
+- * The @a globus_gram_protocol_pack_status_update_message()
++ * globus_gram_protocol_post() or just frame it by calling
++ * globus_gram_protocol_frame_request() and send it by some other mechanism.
++ * The globus_gram_protocol_pack_status_update_message()
+ * function returns the packed message by modifying the @a reply parameter to
+ * point to a new string containing the message. The caller is responsible for
+ * freeing that string.
+@@ -1414,7 +1414,7 @@
+ *
+ * @return
+ * Upon success,
+- * @a globus_gram_protocol_pack_status_update_message() returns
++ * globus_gram_protocol_pack_status_update_message() returns
+ * @a GLOBUS_SUCCESS and modifies the @a reply and @a replysize
+ * parameters as described above.
+ * If an error occurs, an integer error code is returned and the
+@@ -1465,12 +1465,12 @@
+ * @ingroup globus_gram_protocol_pack
+ *
+ * @details
+- * The @a globus_gram_protocol_pack_status_update_message_with_extensions()
++ * The globus_gram_protocol_pack_status_update_message_with_extensions()
+ * function combines its parameters into a GRAM status update message body. The
+ * caller may frame and send the resulting message by calling
+- * @a globus_gram_protocol_post() or just frame it by calling
+- * @a globus_gram_protocol_frame_request() and send it by some other mechanism.
+- * The @a globus_gram_protocol_pack_status_update_message_with_extensions()
++ * globus_gram_protocol_post() or just frame it by calling
++ * globus_gram_protocol_frame_request() and send it by some other mechanism.
++ * The globus_gram_protocol_pack_status_update_message_with_extensions()
+ * function returns the packed message by modifying the @a reply parameter to
+ * point to a new string containing the message. The caller is responsible for
+ * freeing that string.
+@@ -1495,7 +1495,7 @@
+ *
+ * @return
+ * Upon success,
+- * @a globus_gram_protocol_pack_status_update_message_with_extensions()
++ * globus_gram_protocol_pack_status_update_message_with_extensions()
+ * returns @a GLOBUS_SUCCESS and modifies the @a reply and @a replysize
+ * parameters as described above.
+ * If an error occurs, an integer error code is returned and the
+@@ -1602,7 +1602,7 @@
+ * @ingroup globus_gram_protocol_unpack
+ *
+ * @details
+- * The @a globus_gram_protocol_unpack_status_update_message()
++ * The globus_gram_protocol_unpack_status_update_message()
+ * function parses the message packed in the @a reply parameter,
+ * storing the standard message attribute values in its return parameters
+ * @a job_contact, @a status, and @a failure_code. The caller is responsible
+@@ -1614,7 +1614,7 @@
+ * The length of the reply message.
+ * @param job_contact
+ * An output parameter to be set to the job contact string.
+- * If @a globus_gram_protocol_unpack_status_update_message() returns
++ * If globus_gram_protocol_unpack_status_update_message() returns
+ * GLOBUS_SUCCESS, then the caller must free this string using free().
+ * @param status
+ * An output parameter to be set to the integer value of the job's current
+@@ -1625,7 +1625,7 @@
+ *
+ * @return
+ * Upon success,
+- * @a globus_gram_protocol_unpack_status_update_message()
++ * globus_gram_protocol_unpack_status_update_message()
+ * returns @a GLOBUS_SUCCESS and modifies the @a job_contact, @a status,
+ * and @a failure_code parameters as described above.
+ * If an error occurs, an integer error code is returned and the
+@@ -1716,11 +1716,11 @@
+ * @ingroup globus_gram_protocol_unpack
+ *
+ * @details
+- * The @a globus_gram_protocol_unpack_status_update_message_with_extensions()
++ * The globus_gram_protocol_unpack_status_update_message_with_extensions()
+ * function parses the message packed in the @a reply parameter,
+ * storing the message attribute values in its return parameter
+ * @a extensions. The caller is responsible for freeing the @a extensions
+- * hash table by calling @a globus_gram_protocol_hash_destroy().
++ * hash table by calling globus_gram_protocol_hash_destroy().
+ *
+ * @param reply
+ * The unframed reply message to parse.
+@@ -1733,7 +1733,7 @@
+ *
+ * @return
+ * Upon success,
+- * @a globus_gram_protocol_unpack_status_update_message_with_extensions()
++ * globus_gram_protocol_unpack_status_update_message_with_extensions()
+ * returns @a GLOBUS_SUCCESS and modifies the @a extensions
+ * parameter as described above.
+ * If an error occurs, an integer error code is returned and the
+@@ -2222,10 +2222,10 @@
+ * @ingroup globus_gram_protocol_pack
+ *
+ * @details
+- * The @a globus_gram_protocol_pack_job_request() function creates a copy
++ * The globus_gram_protocol_pack_job_request() function creates a copy
+ * of the GRAM version request. The caller may frame
+- * and send the resulting message by calling @a globus_gram_protocol_post()
+- * or just frame it by calling @a globus_gram_protocol_frame_request() and send
++ * and send the resulting message by calling globus_gram_protocol_post()
++ * or just frame it by calling globus_gram_protocol_frame_request() and send
+ * it by some other mechanism. The globus_gram_protocol_pack_version_request()
+ * function returns the packed message by modifying the @a request parameter to
+ * point to a new string containing the message. The caller is responsible for
+@@ -2240,10 +2240,10 @@
+ * of the version request message returned in @a query.
+ *
+ * @return
+- * Upon success, @a globus_gram_protocol_pack_job_request() returns
++ * Upon success, globus_gram_protocol_pack_job_request() returns
+ * GLOBUS_SUCCESS and modifies the @a request and @a requestsize
+ * parameters to point to the values described above. If an error occurs,
+- * @a globus_gram_protocol_pack_version_request() returns an integer
++ * globus_gram_protocol_pack_version_request() returns an integer
+ * error code and the values pointed to by @a request and @a requestsize
+ * are undefined.
+ *
diff --git a/globus-gram-protocol.spec b/globus-gram-protocol.spec
index cb91529..3090de8 100644
--- a/globus-gram-protocol.spec
+++ b/globus-gram-protocol.spec
@@ -9,7 +9,7 @@
Name: globus-gram-protocol
%global _name %(tr - _ <<< %{name})
Version: 9.7
-Release: 5%{?dist}
+Release: 6%{?dist}
Summary: Globus Toolkit - GRAM Protocol Library
Group: System Environment/Libraries
@@ -30,6 +30,9 @@ Source9: epstopdf-2.9.5gw
# Fixes for FHS installation:
# http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6815
Patch0: %{name}.patch
+# Fix doxygen markup
+# http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=7185
+Patch1: %{name}-doxygen.patch
BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n)
Requires: globus-common
@@ -97,6 +100,7 @@ GRAM Protocol Library Documentation Files
%prep
%setup -q -n %{_name}-%{version}
%patch0 -p1
+%patch1 -p1
%if "%{rhel}" == "5"
mkdir bin
@@ -212,6 +216,9 @@ rm -rf $RPM_BUILD_ROOT
%dir %{_docdir}/%{name}-%{version}/perl/Globus/GRAM
%changelog
+* Sun Jun 05 2011 Mattias Ellert <mattias.ellert at fysast.uu.se> - 9.7-6
+- Fix doxygen markup
+
* Mon Apr 25 2011 Mattias Ellert <mattias.ellert at fysast.uu.se> - 9.7-5
- Add README file
More information about the scm-commits
mailing list