diff --git a/docs/manual/doxygen.conf.in b/docs/manual/doxygen.conf.in index 939f38b732..152ef282d6 100644 --- a/docs/manual/doxygen.conf.in +++ b/docs/manual/doxygen.conf.in @@ -11,7 +11,7 @@ WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = YES WARN_AS_ERROR = NO -INPUT = ../../src/core/ddsc/include/dds/ ../../src/ddsrt/include/dds/ddsrt/retcode.h +INPUT = ../../src/core/ddsc/include/dds/ ../../src/ddsrt/include/dds/ddsrt/retcode.h ../../src/ddsrt/include/dds/ddsrt/log.h FILE_PATTERNS = *.c *.idl **.h RECURSIVE = YES EXCLUDE_SYMLINKS = NO diff --git a/src/core/ddsc/include/dds/dds.h b/src/core/ddsc/include/dds/dds.h index 5a7484683a..a9be3535db 100644 --- a/src/core/ddsc/include/dds/dds.h +++ b/src/core/ddsc/include/dds/dds.h @@ -3086,8 +3086,8 @@ dds_waitset_wait_until( * etc. This continues until it has traversed the entire history cache or has gathered * `maxs` samples. * - * The @ref `dds_read` operation can be used to mark the returned samples as "read"; the - * @ref `dds_take` operation can be used to also remove the returned samples from the + * The @ref dds_read operation can be used to mark the returned samples as "read"; the + * @ref dds_take operation can be used to also remove the returned samples from the * history cache. * * For the plain `dds_peek` operation, all instances and samples match. This is different @@ -3104,7 +3104,7 @@ dds_waitset_wait_until( * - all of `buf[0]` .. `buf[k-1]` must be pointers to outstanding loans; and * - `k` = `bufsz` or `buf[k]` is a null pointer; where * - `1 <= k < bufsz`; and - * - all these outstanding loans are returned as-if through @ref `dds_return_loan`; and + * - all these outstanding loans are returned as-if through @ref dds_return_loan; and * - the result will be as if `buf[0]` had been a null pointer on entry. * * - If `buf[0]` on entry is any other address, then: @@ -3153,7 +3153,7 @@ dds_peek( * @ingroup reading * @component read_data * - * See @ref `dds_peek`. The matching criterion referred to there is that the + * See @ref dds_peek. The matching criterion referred to there is that the * sample/view/instance states must match the specification in the `mask` parameter. * * If the sample/view/instance state component in the mask is 0 and `reader_or_condition` @@ -3196,7 +3196,7 @@ dds_peek_mask( * @ingroup reading * @component read_data * - * See @ref `dds_peek`. The matching criterion referred to there is that the instance + * See @ref dds_peek. The matching criterion referred to there is that the instance * handle must equal the `handle` parameter. * * @param[in] reader_or_condition Reader, readcondition or querycondition entity. @@ -3235,7 +3235,7 @@ dds_peek_instance( * @ingroup reading * @component read_data * - * See @ref `dds_peek`. The matching criterion referred to there is that: + * See @ref dds_peek. The matching criterion referred to there is that: * - the instance handle must equal the `handle` parameter; and * - the sample/view/instance states must match the specification in the `mask` parameter. * @@ -3317,8 +3317,8 @@ dds_peek_next( * etc. This continues until it has traversed the entire history cache or has gathered * `maxs` samples. * - * The @ref `dds_peek` operation can be read samples without marking them as "read"; the - * @ref `dds_take` operation can be used to also remove the returned samples from the + * The @ref dds_peek operation can be read samples without marking them as "read"; the + * @ref dds_take operation can be used to also remove the returned samples from the * history cache. * * For the plain `dds_read` operation, all instances and samples match. This is different @@ -3335,7 +3335,7 @@ dds_peek_next( * - all of `buf[0]` .. `buf[k-1]` must be pointers to outstanding loans; and * - `k` = `bufsz` or `buf[k]` is a null pointer; where * - `1 <= k < bufsz`; and - * - all these outstanding loans are returned as-if through @ref `dds_return_loan`; and + * - all these outstanding loans are returned as-if through @ref dds_return_loan; and * - the result will be as if `buf[0]` had been a null pointer on entry. * * - If `buf[0]` on entry is any other address, then: @@ -3416,7 +3416,7 @@ dds_read_wl( * @ingroup reading * @component read_data * - * See @ref `dds_read`. The matching criterion referred to there is that the + * See @ref dds_read. The matching criterion referred to there is that the * sample/view/instance states must match the specification in the `mask` parameter. * * If the sample/view/instance state component in the mask is 0 and `reader_or_condition` @@ -3459,7 +3459,7 @@ dds_read_mask( * @ingroup reading * @component read_data * - * @deprecated Alias for @ref `dds_read_mask` where `bufsz` = `maxs`. + * @deprecated Alias for @ref dds_read_mask where `bufsz` = `maxs`. * * @param[in] reader_or_condition Reader, readcondition or querycondition entity. * @param[in,out] buf An array of `maxs` pointers to samples. @@ -3493,7 +3493,7 @@ dds_read_mask_wl( * @ingroup reading * @component read_data * - * See @ref `dds_read`. The matching criterion referred to there is that the instance + * See @ref dds_read. The matching criterion referred to there is that the instance * handle must equal the `handle` parameter. * * @param[in] reader_or_condition Reader, readcondition or querycondition entity. @@ -3532,7 +3532,7 @@ dds_read_instance( * @ingroup reading * @component read_data * - * @deprecated Alias for @ref `dds_read_instance` where `bufsz` = `maxs`. + * @deprecated Alias for @ref dds_read_instance where `bufsz` = `maxs`. * * @param[in] reader_or_condition Reader, readcondition or querycondition entity. * @param[in,out] buf An array of `maxs` pointers to samples. @@ -3568,7 +3568,7 @@ dds_read_instance_wl( * @ingroup reading * @component read_data * - * See @ref `dds_read`. The matching criterion referred to there is that: + * See @ref dds_read. The matching criterion referred to there is that: * - the instance handle must equal the `handle` parameter; and * - the sample/view/instance states must match the specification in the `mask` parameter. * @@ -3616,7 +3616,7 @@ dds_read_instance_mask( * @ingroup reading * @component read_data * - * @deprecated Alias for @ref `dds_read_instance_mask` where `bufsz` = `maxs`. + * @deprecated Alias for @ref dds_read_instance_mask where `bufsz` = `maxs`. * * @param[in] reader_or_condition Reader, readcondition or querycondition entity. * @param[in,out] buf An array of `maxs` pointers to samples. @@ -3682,7 +3682,7 @@ dds_read_next( * @ingroup reading * @component read_data * - * @deprecated Alias for @ref `dds_read_next`. + * @deprecated Alias for @ref dds_read_next. * * @param[in] reader The reader entity. * @param[in,out] buf A pointer to a sample. @@ -3716,8 +3716,8 @@ dds_read_next_wl( * continues until it has traversed the entire history cache or has gathered `maxs` * samples. * - * The @ref `dds_read` operation can be used to read samples without removing them from - * the history cache but marking them as "read"; the @ref `dds_peek` operation can be used + * The @ref dds_read operation can be used to read samples without removing them from + * the history cache but marking them as "read"; the @ref dds_peek operation can be used * to read samples from the cache without changing any internal state. * * For the plain `dds_take` operation, all instances and samples match. This is different @@ -3734,7 +3734,7 @@ dds_read_next_wl( * - all of `buf[0]` .. `buf[k-1]` must be pointers to outstanding loans; and * - `k` = `bufsz` or `buf[k]` is a null pointer; where * - `1 <= k < bufsz`; and - * - all these outstanding loans are returned as-if through @ref `dds_return_loan`; and + * - all these outstanding loans are returned as-if through @ref dds_return_loan; and * - the result will be as if `buf[0]` had been a null pointer on entry. * * - If `buf[0]` on entry is any other address, then: @@ -3783,7 +3783,7 @@ dds_take( * @ingroup reading * @component read_data * - * @deprecated Alias for @ref `dds_take` where `bufsz` = `maxs`. + * @deprecated Alias for @ref dds_take where `bufsz` = `maxs`. * * @param[in] reader_or_condition Reader, readcondition or querycondition entity. * @param[in,out] buf An array of `maxs` pointers to samples. @@ -3815,7 +3815,7 @@ dds_take_wl( * @ingroup reading * @component read_data * - * See @ref `dds_take`. The matching criterion referred to there is that the + * See @ref dds_take. The matching criterion referred to there is that the * sample/view/instance states must match the specification in the `mask` parameter. * * If the sample/view/instance state component in the mask is 0 and `reader_or_condition` @@ -3892,7 +3892,7 @@ dds_take_mask_wl( * @ingroup reading * @component read_data * - * See @ref `dds_take`. The matching criterion referred to there is that the instance + * See @ref dds_take. The matching criterion referred to there is that the instance * handle must equal the `handle` parameter. * * @param[in] reader_or_condition Reader, readcondition or querycondition entity. @@ -3931,7 +3931,7 @@ dds_take_instance( * @ingroup reading * @component read_data * - * @deprecated Alias for @ref `dds_take_instance` where `bufsz` = `maxs`. + * @deprecated Alias for @ref dds_take_instance where `bufsz` = `maxs`. * * @param[in] reader_or_condition Reader, readcondition or querycondition entity. * @param[in,out] buf An array of `maxs` pointers to samples. @@ -3967,7 +3967,7 @@ dds_take_instance_wl( * @ingroup reading * @component read_data * - * See @ref `dds_take`. The matching criterion referred to there is that: + * See @ref dds_take. The matching criterion referred to there is that: * - the instance handle must equal the `handle` parameter; and * - the sample/view/instance states must match the specification in the `mask` parameter. * @@ -4015,7 +4015,7 @@ dds_take_instance_mask( * @ingroup reading * @component read_data * - * @deprecated Alias for @ref `dds_take_instance_mask` where `bufsz` = `maxs`. + * @deprecated Alias for @ref dds_take_instance_mask where `bufsz` = `maxs`. * * @param[in] reader_or_condition Reader, readcondition or querycondition entity. * @param[in,out] buf An array of `maxs` pointers to samples. @@ -4081,7 +4081,7 @@ dds_take_next( * @ingroup reading * @component read_data * - * @deprecated Alias for @ref `dds_take_next`. + * @deprecated Alias for @ref dds_take_next. * * @param[in] reader The reader entity. * @param[in,out] buf A pointer to a sample. @@ -4276,10 +4276,10 @@ dds_take_with_collector ( * the application, other options may exist as well. * * The data is left in the reader history cache and the sample state and view state of the returned samples and their - * instances are not updated; @ref `dds_readcdr` updates these states; @ref `dds_takecdr` removes the data + * instances are not updated; @ref dds_readcdr updates these states; @ref dds_takecdr removes the data * from the history cache. * - * The returned references must eventually be released by calling @ref `ddsi_serdata_unref`. There is no guarantee + * The returned references must eventually be released by calling @ref ddsi_serdata_unref. There is no guarantee * the type pointer survives beyond the existence of the reader from which the references were read. * * When using a readcondition or querycondition, their masks are or'd with the given mask. @@ -4287,7 +4287,7 @@ dds_take_with_collector ( * If the sample/view/instance state component in the mask is 0 and there is no read or query condition, * to combine it with, it is treated as equivalent to any sample/view/instance state. * - * Note that this is a simple wrapper around @ref `dds_peek_with_collector`. + * Note that this is a simple wrapper around @ref dds_peek_with_collector. * * @param[in] reader_or_condition Reader, readcondition or querycondition entity. * @param[out] buf Filled with references @ref ddsi_serdata structures. @@ -4329,10 +4329,10 @@ dds_peekcdr( * the application, other options may exist as well. * * The data is left in the reader history cache and the sample state and view state of the returned samples and their - * instances are not updated; @ref `dds_readcdr` updates these states; @ref `dds_takecdr` removes the data + * instances are not updated; @ref dds_readcdr updates these states; @ref dds_takecdr removes the data * from the history cache. * - * The returned references must eventually be released by calling @ref `ddsi_serdata_unref`. There is no guarantee + * The returned references must eventually be released by calling @ref ddsi_serdata_unref. There is no guarantee * the type pointer survives beyond the existence of the reader from which the references were read. * * When using a readcondition or querycondition, their masks are or'd with the given mask. @@ -4340,7 +4340,7 @@ dds_peekcdr( * If the sample/view/instance state component in the mask is 0 and there is no read or query condition, * to combine it with, it is treated as equivalent to any sample/view/instance state. * - * Note that this is a simple wrapper around @ref `dds_peek_with_collector`. + * Note that this is a simple wrapper around @ref dds_peek_with_collector. * * @param[in] reader_or_condition Reader, readcondition or querycondition entity. * @param[out] buf Filled with references @ref ddsi_serdata structures. @@ -4384,10 +4384,10 @@ dds_peekcdr_instance ( * the application, other options may exist as well. * * The data is left in the reader history cache and the sample state and view state of the returned samples and their - * instances are updated; @ref `dds_peekcdr` returns the data without updating these states; @ref `dds_takecdr` + * instances are updated; @ref dds_peekcdr returns the data without updating these states; @ref dds_takecdr * removes the data from the history cache. * - * The returned references must eventually be released by calling @ref `ddsi_serdata_unref`. There is no guarantee + * The returned references must eventually be released by calling @ref ddsi_serdata_unref. There is no guarantee * the type pointer survives beyond the existence of the reader from which the references were read. * * When using a readcondition or querycondition, their masks are or'd with the given mask. @@ -4395,7 +4395,7 @@ dds_peekcdr_instance ( * If the sample/view/instance state component in the mask is 0 and there is no read or query condition, * to combine it with, it is treated as equivalent to any sample/view/instance state. * - * Note that this is a simple wrapper around @ref `dds_read_with_collector`. + * Note that this is a simple wrapper around @ref dds_read_with_collector. * * @param[in] reader_or_condition Reader, readcondition or querycondition entity. * @param[out] buf Filled with references @ref ddsi_serdata structures. @@ -4437,10 +4437,10 @@ dds_readcdr( * the application, other options may exist as well. * * The data is left in the reader history cache and the sample state and view state of the returned samples and their - * instances are updated; @ref `dds_peekcdr` returns the data without updating these states; @ref `dds_takecdr` + * instances are updated; @ref dds_peekcdr returns the data without updating these states; @ref dds_takecdr * removes the data from the history cache. * - * The returned references must eventually be released by calling @ref `ddsi_serdata_unref`. There is no guarantee + * The returned references must eventually be released by calling @ref ddsi_serdata_unref. There is no guarantee * the type pointer survives beyond the existence of the reader from which the references were read. * * When using a readcondition or querycondition, their masks are or'd with the given mask. @@ -4448,7 +4448,7 @@ dds_readcdr( * If the sample/view/instance state component in the mask is 0 and there is no read or query condition, * to combine it with, it is treated as equivalent to any sample/view/instance state. * - * Note that this is a simple wrapper around @ref `dds_read_with_collector`. + * Note that this is a simple wrapper around @ref dds_read_with_collector. * * @param[in] reader_or_condition Reader, readcondition or querycondition entity. * @param[out] buf Filled with references @ref ddsi_serdata structures. @@ -4491,11 +4491,11 @@ dds_readcdr_instance ( * reference of the serialized representation. If the underlying implementation (`struct ddsi_sertype`) is known to * the application, other options may exist as well. * - * The data is removed from the reader history cache; @ref `dds_peekcdr` leaves them in and leaves the sample and - * view states unchanged; @ref `dds_readcdr` leaves the data in the cache but does update the sample and view + * The data is removed from the reader history cache; @ref dds_peekcdr leaves them in and leaves the sample and + * view states unchanged; @ref dds_readcdr leaves the data in the cache but does update the sample and view * states. * - * The returned references must eventually be released by calling @ref `ddsi_serdata_unref`. There is no guarantee + * The returned references must eventually be released by calling @ref ddsi_serdata_unref. There is no guarantee * the type pointer survives beyond the existence of the reader from which the references were read. * * When using a readcondition or querycondition, their masks are or'd with the given mask. @@ -4503,7 +4503,7 @@ dds_readcdr_instance ( * If the sample/view/instance state component in the mask is 0 and there is no read or query condition, * to combine it with, it is treated as equivalent to any sample/view/instance state. * - * Note that this is a simple wrapper around @ref `dds_take_with_collector`. + * Note that this is a simple wrapper around @ref dds_take_with_collector. * * @param[in] reader_or_condition Reader, readcondition or querycondition entity. * @param[out] buf Filled with references @ref ddsi_serdata structures. @@ -4544,11 +4544,11 @@ dds_takecdr( * reference of the serialized representation. If the underlying implementation (`struct ddsi_sertype`) is known to * the application, other options may exist as well. * - * The data is removed from the reader history cache; @ref `dds_peekcdr` leaves them in and leaves the sample and - * view states unchanged; @ref `dds_readcdr` leaves the data in the cache but does update the sample and view + * The data is removed from the reader history cache; @ref dds_peekcdr leaves them in and leaves the sample and + * view states unchanged; @ref dds_readcdr leaves the data in the cache but does update the sample and view * states. * - * The returned references must eventually be released by calling @ref `ddsi_serdata_unref`. There is no guarantee + * The returned references must eventually be released by calling @ref ddsi_serdata_unref. There is no guarantee * the type pointer survives beyond the existence of the reader from which the references were read. * * When using a readcondition or querycondition, their masks are or'd with the given mask. @@ -4556,7 +4556,7 @@ dds_takecdr( * If the sample/view/instance state component in the mask is 0 and there is no read or query condition, * to combine it with, it is treated as equivalent to any sample/view/instance state. * - * Note that this is a simple wrapper around @ref `dds_take_with_collector`. + * Note that this is a simple wrapper around @ref dds_take_with_collector. * * @param[in] reader_or_condition Reader, readcondition or querycondition entity. * @param[out] buf Filled with references @ref ddsi_serdata structures. diff --git a/src/core/ddsc/include/dds/ddsc/dds_loaned_sample.h b/src/core/ddsc/include/dds/ddsc/dds_loaned_sample.h index 9ee1bd8d42..cc9469f0bb 100644 --- a/src/core/ddsc/include/dds/ddsc/dds_loaned_sample.h +++ b/src/core/ddsc/include/dds/ddsc/dds_loaned_sample.h @@ -34,6 +34,7 @@ struct dds_psmx_endpoint; /** * @brief State of the data contained in a memory block + * @ingroup loaned_sample */ typedef enum dds_loaned_sample_state { DDS_LOANED_SAMPLE_STATE_UNITIALIZED, @@ -45,11 +46,13 @@ typedef enum dds_loaned_sample_state { /** * @brief Identifier used to distinguish between raw data types (C/C++/Python/...) + * @ingroup loaned_sample */ typedef uint32_t dds_loan_data_type_t; /** * @brief Definition for function to free a loaned sample + * @ingroup loaned_sample * * @param[in] loaned_sample A loaned sample */ @@ -58,6 +61,7 @@ typedef void (*dds_loaned_sample_free_f) (struct dds_loaned_sample *loaned_sampl /** * @brief Container for implementation specific operations + * @ingroup loaned_sample */ typedef struct dds_loaned_sample_ops { dds_loaned_sample_free_f free; @@ -75,6 +79,7 @@ typedef struct dds_loaned_sample_origin { /** * @brief The definition of a block of memory originating from a PSMX + * @ingroup loaned_sample */ typedef struct dds_loaned_sample { dds_loaned_sample_ops_t ops; //!< the implementation specific ops for this sample @@ -86,6 +91,7 @@ typedef struct dds_loaned_sample { /** * @brief Generic function to increase the refcount for a loaned sample + * @ingroup loaned_sample * * @param[in] loaned_sample A loaned sample */ @@ -95,6 +101,7 @@ DDS_INLINE_EXPORT inline void ddsrt_nonnull_all dds_loaned_sample_ref (dds_loane /** * @brief Generic function to decrease the refcount for a loaned sample + * @ingroup loaned_sample * * Calls the PSMX plugin specific free function once the reference count reaches 0. * diff --git a/src/core/ddsc/include/dds/ddsc/dds_psmx.h b/src/core/ddsc/include/dds/ddsc/dds_psmx.h index bb3f401cca..2ccf4e87d9 100644 --- a/src/core/ddsc/include/dds/ddsc/dds_psmx.h +++ b/src/core/ddsc/include/dds/ddsc/dds_psmx.h @@ -11,6 +11,9 @@ /** * @defgroup psmx (Publish Subscribe Message Exchange) * @ingroup dds + * The Publish Subscribe Message Exchange (PSMX) interface allows implementing additional methods of pub-sub data-exchange + * as an alternative to Cyclone's networked transport. The PSMX interface allows to load implementations as plugins, + * so there is no need for compile-time linking. */ #ifndef DDS_PSMX_H #define DDS_PSMX_H @@ -34,6 +37,7 @@ struct dds_psmx_endpoint_list_elem; /** * @brief Type of the PSMX endpoint + * @ingroup psmx */ typedef enum dds_psmx_endpoint_type { DDS_PSMX_ENDPOINT_TYPE_UNSET, @@ -43,6 +47,7 @@ typedef enum dds_psmx_endpoint_type { /** * @brief Identifier for the PSMX instance + * @ingroup psmx */ typedef uint32_t dds_psmx_instance_id_t; @@ -55,6 +60,7 @@ typedef uint32_t dds_psmx_features_t; /** * @brief describes the data which is transferred in addition to just the sample + * @ingroup psmx */ typedef struct dds_psmx_metadata { dds_loaned_sample_state_t sample_state; @@ -70,6 +76,7 @@ typedef struct dds_psmx_metadata { /** * @brief identifier used to distinguish between PSMX instances on nodes + * @ingroup psmx */ typedef struct dds_psmx_node_identifier { @@ -78,6 +85,7 @@ typedef struct dds_psmx_node_identifier /** * @brief Definition for function that checks QoS support + * @ingroup psmx * * Definition for function that checks whether the provided QoS * is supported by the PSMX implementation. @@ -92,7 +100,7 @@ typedef bool (*dds_psmx_type_qos_supported_fn) (struct dds_psmx *psmx_instance, /** * @brief Definition for function to create a topic - * + * @ingroup psmx * Definition for a function that is called to create a new topic * for a PSMX instance. * @@ -110,7 +118,7 @@ typedef struct dds_psmx_topic * (* dds_psmx_create_topic_fn) ( /** * @brief Definition for function to destruct a topic - * + * @ingroup psmx * Definition for a function that is called on topic destruction. * * @param[in] psmx_topic The PSMX topic to destruct @@ -121,7 +129,7 @@ typedef dds_return_t (*dds_psmx_delete_topic_fn) (struct dds_psmx_topic *psmx_to /** * @brief Function definition for pubsub message exchange cleanup - * + * @ingroup psmx * @param[in] psmx_instance the psmx instance to de-initialize * @returns a DDS return code */ @@ -129,7 +137,7 @@ typedef dds_return_t (* dds_psmx_deinit_fn) (struct dds_psmx *psmx_instance); /** * @brief Definition for PSMX locator generation function - * + * @ingroup psmx * Returns a locator which is unique between nodes, but identical for instances on * the same node * @@ -140,7 +148,7 @@ typedef dds_psmx_node_identifier_t (* dds_psmx_get_node_identifier_fn) (const st /** * @brief Definition for PSMX function to get supported features - * + * @ingroup psmx * Returns an integer with the flags set for the features that are * supported by the provided PSMX instance. * @@ -152,6 +160,7 @@ typedef dds_psmx_features_t (* dds_psmx_supported_features_fn) (const struct dds /** * @brief functions which are used on a PSMX instance + * @ingroup psmx */ typedef struct dds_psmx_ops { dds_psmx_type_qos_supported_fn type_qos_supported; @@ -164,6 +173,7 @@ typedef struct dds_psmx_ops { /** * @brief Definition of function to create an endpoint for a topic + * @ingroup psmx * * @param[in] psmx_topic The PSMX topic to create the endpoint for * @param[in] endpoint_type The type of endpoint to create (publisher or subscriber) @@ -173,6 +183,7 @@ typedef struct dds_psmx_endpoint * (* dds_psmx_create_endpoint_fn) (struct dds_p /** * @brief Definition of function to delete an PSMX endpoint + * @ingroup psmx * * @param[in] psmx_endpoint The endpoint to be deleted * @returns a DDS return code @@ -181,6 +192,7 @@ typedef dds_return_t (* dds_psmx_delete_endpoint_fn) (struct dds_psmx_endpoint * /** * @brief functions which are used on a PSMX topic + * @ingroup psmx */ typedef struct dds_psmx_topic_ops { dds_psmx_create_endpoint_fn create_endpoint; @@ -190,6 +202,7 @@ typedef struct dds_psmx_topic_ops { /** * @brief Definition for function to requests a loan from the PSMX + * @ingroup psmx * * @param[in] psmx_endpoint the endpoint to loan from * @param[in] size_requested the size of the loan requested @@ -199,6 +212,7 @@ typedef dds_loaned_sample_t * (* dds_psmx_endpoint_request_loan_fn) (struct dds_ /** * @brief Definition of function to write data on a PSMX endpoint + * @ingroup psmx * * @param[in] psmx_endpoint The endpoint to publish the data on * @param[in] data The data to publish @@ -208,6 +222,7 @@ typedef dds_return_t (* dds_psmx_endpoint_write_fn) (struct dds_psmx_endpoint *p /** * @brief Definition of function to take data from an PSMX endpoint + * @ingroup psmx * * Used in a poll based implementation. * @@ -218,6 +233,7 @@ typedef dds_loaned_sample_t * (* dds_psmx_endpoint_take_fn) (struct dds_psmx_end /** * @brief Definition of function to set the a callback function on an PSMX endpoint + * @ingroup psmx * * @param[in] psmx_endpoint the endpoint to set the callback function on * @param[in] reader the DDS reader associated with the endpoint @@ -227,6 +243,7 @@ typedef dds_return_t (* dds_psmx_endpoint_on_data_available_fn) (struct dds_psmx /** * @brief Functions that are used on a PSMX endpoint + * @ingroup psmx */ typedef struct dds_psmx_endpoint_ops { dds_psmx_endpoint_request_loan_fn request_loan; @@ -237,6 +254,7 @@ typedef struct dds_psmx_endpoint_ops { /** * @brief the top-level entry point on the PSMX is bound to a specific implementation of a PSMX + * @ingroup psmx */ typedef struct dds_psmx { dds_psmx_ops_t ops; //!< associated functions @@ -249,6 +267,7 @@ typedef struct dds_psmx { /** * @brief the topic-level PSMX + * @ingroup psmx * * this will exchange data for readers and writers which are matched through discovery * will only exchange a single type of data @@ -265,6 +284,7 @@ typedef struct dds_psmx_topic { /** * @brief the definition of one instance of a dds reader/writer using a PSMX instance + * @ingroup psmx */ typedef struct dds_psmx_endpoint { dds_psmx_endpoint_ops_t ops; //!< associated functions @@ -275,6 +295,7 @@ typedef struct dds_psmx_endpoint { /** * @brief adds a topic to the list + * @ingroup psmx * * will create the first list entry if it does not yet exist * @@ -286,6 +307,7 @@ DDS_EXPORT dds_return_t dds_add_psmx_topic_to_list (struct dds_psmx_topic *psmx_ /** * @brief removes a topic from the list + * @ingroup psmx * * will set the pointer to the list to null if the last entry is removed * @@ -297,6 +319,7 @@ DDS_EXPORT dds_return_t dds_remove_psmx_topic_from_list (struct dds_psmx_topic * /** * @brief adds an endpoint to the list + * @ingroup psmx * * will create the first list entry if it does not yet exist * @@ -308,6 +331,7 @@ DDS_EXPORT dds_return_t dds_add_psmx_endpoint_to_list (struct dds_psmx_endpoint /** * @brief removes an endpoint from the list + * @ingroup psmx * * will set the pointer to the list to null if the last entry is removed * @@ -319,6 +343,7 @@ DDS_EXPORT dds_return_t dds_remove_psmx_endpoint_from_list (struct dds_psmx_endp /** * @brief initialization function for PSMX instance + * @ingroup psmx * * Should be called from all constructors of class which inherit from dds_psmx_t * @@ -329,6 +354,7 @@ DDS_EXPORT dds_return_t dds_psmx_init_generic (struct dds_psmx *psmx); /** * @brief cleanup function for a PSMX instance + * @ingroup psmx * * Should be called from all destructors of classes which inherit from dds_psmx_t * @@ -339,6 +365,7 @@ DDS_EXPORT dds_return_t dds_psmx_cleanup_generic (struct dds_psmx *psmx); /** * @brief init function for topic + * @ingroup psmx * * Should be called from all constructors of classes which inherit from struct dds_psmx_topic * @@ -354,6 +381,7 @@ DDS_EXPORT dds_return_t dds_psmx_topic_init_generic (struct dds_psmx_topic *psmx /** * @brief cleanup function for a topic + * @ingroup psmx * * Should be called from all destructors of classes which inherit from struct dds_psmx_topic * @@ -365,6 +393,7 @@ DDS_EXPORT dds_return_t dds_psmx_topic_cleanup_generic(struct dds_psmx_topic *ps /** * @brief Gets the supported features for a PSMX instance + * @ingroup psmx * * Returns the set of supported features for the provided PSMX instance. * diff --git a/src/core/ddsc/include/dds/ddsc/dds_public_dynamic_type.h b/src/core/ddsc/include/dds/ddsc/dds_public_dynamic_type.h index 94c3f670f2..5bbcd97054 100644 --- a/src/core/ddsc/include/dds/ddsc/dds_public_dynamic_type.h +++ b/src/core/ddsc/include/dds/ddsc/dds_public_dynamic_type.h @@ -316,7 +316,7 @@ DDS_EXPORT dds_dynamic_type_t dds_dynamic_type_create (dds_entity_t entity, dds_ * @component dynamic_type_api * * @param[in,out] type Dynamic Type to set the extensibility for. This can be a structure, union, bitmask or enum type. This type must be in the CONSTRUCTING state and have no members added. - * @param[in] extensibility The extensibility to set (@ref enum dds_dynamic_type_extensibility). + * @param[in] extensibility The extensibility to set (@ref dds_dynamic_type_extensibility). * * @return dds_return_t Return code. In case of an error, the return code field in the provided type is also set to this value. * diff --git a/src/core/ddsc/include/dds/ddsc/dds_public_loan_api.h b/src/core/ddsc/include/dds/ddsc/dds_public_loan_api.h index 992a2a736d..89013eca02 100644 --- a/src/core/ddsc/include/dds/ddsc/dds_public_loan_api.h +++ b/src/core/ddsc/include/dds/ddsc/dds_public_loan_api.h @@ -33,8 +33,8 @@ extern "C" { * @ingroup loan * * Borrow a sample from the entity, which currently must be a writer. This sample - * can then be returned using @ref `dds_return_loan` or can be used to publish data - * using @ref `dds_write` or @ref `dds_writedispose`. + * can then be returned using @ref dds_return_loan or can be used to publish data + * using @ref dds_write or @ref dds_writedispose. * * If the topic type has a fixed size (and so no internal pointers) and a PSMX interface is configured, * the memory will be borrowed from the PSMX implementation, which allows Cyclone to avoid copies @@ -65,13 +65,13 @@ DDS_EXPORT dds_return_t dds_request_loan (dds_entity_t entity, void **sample); * @component read_data * * Used to release middleware-owned samples returned by a read/take operation and samples - * borrowed from the writer using @ref `dds_request_loan`. + * borrowed from the writer using @ref dds_request_loan. * - * For reader loans, the @ref `dds_read` and @ref `dds_take` operations implicitly return + * For reader loans, the @ref dds_read and @ref dds_take operations implicitly return * outstanding loans referenced by the sample array passed in. Looping until no data is * returned therefore often eliminates the need for calling this function. * - * For writer loans, a @ref `dds_write` operation takes over the loan. Consequently, this + * For writer loans, a @ref dds_write operation takes over the loan. Consequently, this * function is only needed in the exceptional case where a loan is taken but ultimately * not used to publish data. * @@ -117,8 +117,8 @@ DDS_EXPORT bool dds_is_shared_memory_available (const dds_entity_t entity); * @ingroup loan * * Borrow a sample of a specified size from the entity, which currently must be a - * writer. This sample can then be returned using @ref `dds_return_loan` or can be - * used to publish data using @ref `dds_write` or @ref `dds_writedispose`. + * writer. This sample can then be returned using @ref dds_return_loan or can be + * used to publish data using @ref dds_write or @ref dds_writedispose. * * @note The function can only be used if dds_is_shared_memory_available is * true for the writer.