Repository: qpid-proton Updated Branches: refs/heads/cjansen-cpp-client f9bcbb5a5 -> 035b6957c
NO-JIRA: Fix minor doxygen warnings in the proton-c headers. Project: http://git-wip-us.apache.org/repos/asf/qpid-proton/repo Commit: http://git-wip-us.apache.org/repos/asf/qpid-proton/commit/cdad4dd7 Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/cdad4dd7 Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/cdad4dd7 Branch: refs/heads/cjansen-cpp-client Commit: cdad4dd766460aa38f12e0b54ef902a20e8d77ea Parents: f9bcbb5 Author: Alan Conway <[email protected]> Authored: Tue Jul 14 18:52:37 2015 -0400 Committer: Alan Conway <[email protected]> Committed: Tue Jul 14 18:52:37 2015 -0400 ---------------------------------------------------------------------- proton-c/include/proton/codec.h | 11 +++++------ proton-c/include/proton/event.h | 3 ++- proton-c/include/proton/handlers.h | 1 - proton-c/include/proton/reactor.h | 1 - proton-c/include/proton/selectable.h | 5 ++--- 5 files changed, 9 insertions(+), 12 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/cdad4dd7/proton-c/include/proton/codec.h ---------------------------------------------------------------------- diff --git a/proton-c/include/proton/codec.h b/proton-c/include/proton/codec.h index 05b8f6f..3f6a6dc 100644 --- a/proton-c/include/proton/codec.h +++ b/proton-c/include/proton/codec.h @@ -509,8 +509,7 @@ PN_EXTERN int pn_data_format(pn_data_t *data, char *bytes, size_t *size); * @param bytes the buffer for encoded data * @param size the size of the buffer * - * @param ssize_t returns the size of the encoded data on success or - * an error code on failure + * @return the size of the encoded data on success or an error code on failure */ PN_EXTERN ssize_t pn_data_encode(pn_data_t *data, char *bytes, size_t size); @@ -519,7 +518,7 @@ PN_EXTERN ssize_t pn_data_encode(pn_data_t *data, char *bytes, size_t size); * * @param data the data object * - * @param ssize_t returns the size of the encoded data or an error code if data is invalid. + * @return the size of the encoded data or an error code if data is invalid. */ PN_EXTERN ssize_t pn_data_encoded_size(pn_data_t *data); @@ -545,7 +544,7 @@ PN_EXTERN ssize_t pn_data_decode(pn_data_t *data, const char *bytes, size_t size /** * Puts an empty list value into a pn_data_t. Elements may be filled * by entering the list node using ::pn_data_enter() and using - * ::pn_data_put_* to add the desired contents. Once done, + * pn_data_put_* to add the desired contents. Once done, * ::pn_data_exit() may be used to return to the current level in the * tree and put more values. * @@ -915,7 +914,7 @@ PN_EXTERN size_t pn_data_get_map(pn_data_t *data); * If the current node is an array, return the number of elements in * the array, otherwise return 0. Array data can be accessed by * entering the array. If the array is described, the first child node - * will be the descriptor, and the remaining @var count child nodes + * will be the descriptor, and the remaining count child nodes * will be the elements of the array. * * @code @@ -1249,7 +1248,7 @@ PN_EXTERN pn_handle_t pn_data_point(pn_data_t *data); * otherwise it will return true. * * @param data a pn_data_t object - * @param handle a handle referencing the saved navigational state + * @param point a handle referencing the saved navigational state * @return true iff the prior navigational state was restored */ PN_EXTERN bool pn_data_restore(pn_data_t *data, pn_handle_t point); http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/cdad4dd7/proton-c/include/proton/event.h ---------------------------------------------------------------------- diff --git a/proton-c/include/proton/event.h b/proton-c/include/proton/event.h index 43329c4..d10927b 100644 --- a/proton-c/include/proton/event.h +++ b/proton-c/include/proton/event.h @@ -350,8 +350,9 @@ PN_EXTERN void pn_collector_release(pn_collector_t *collector); * this happens, this operation will return a NULL pointer. * * @param[in] collector a collector object - * @param[in] type the event type + * @param[in] clazz class of the context * @param[in] context the event context + * @param[in] type the event type * * @return a pointer to the newly created event or NULL if the event * was elided http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/cdad4dd7/proton-c/include/proton/handlers.h ---------------------------------------------------------------------- diff --git a/proton-c/include/proton/handlers.h b/proton-c/include/proton/handlers.h index 304d0e6..f61e04c 100644 --- a/proton-c/include/proton/handlers.h +++ b/proton-c/include/proton/handlers.h @@ -36,7 +36,6 @@ extern "C" { * Reactor API for proton. * * @defgroup handlers Handlers - * @ingroup handlers * @{ */ http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/cdad4dd7/proton-c/include/proton/reactor.h ---------------------------------------------------------------------- diff --git a/proton-c/include/proton/reactor.h b/proton-c/include/proton/reactor.h index 6f52d22..ed223e7 100644 --- a/proton-c/include/proton/reactor.h +++ b/proton-c/include/proton/reactor.h @@ -38,7 +38,6 @@ extern "C" { * Reactor API for proton. * * @defgroup reactor Reactor - * @ingroup reactor * @{ */ http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/cdad4dd7/proton-c/include/proton/selectable.h ---------------------------------------------------------------------- diff --git a/proton-c/include/proton/selectable.h b/proton-c/include/proton/selectable.h index 07cb212..7b0fa02 100644 --- a/proton-c/include/proton/selectable.h +++ b/proton-c/include/proton/selectable.h @@ -53,9 +53,7 @@ typedef pn_iterator_t pn_selectables_t; * * Every selectable is associated with exactly one file descriptor. * Selectables may be interested in three kinds of events, read - * events, write events, and timer events. A selectable will express - * its interest in these events through the ::pn_selectable_capacity(), - * ::pn_selectable_pending(), and ::pn_selectable_deadline() calls. + * events, write events, and timer events. * * When a read, write, or timer event occurs, the selectable must be * notified by calling ::pn_selectable_readable(), @@ -237,6 +235,7 @@ PN_EXTERN void pn_selectable_free(pn_selectable_t *selectable); * writable, and expired events into the supplied collector. * * @param[in] selectable a selectable objet + * @param[in] collector a collector object */ PN_EXTERN void pn_selectable_collect(pn_selectable_t *selectable, pn_collector_t *collector); --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
