Skip to content
Snippets Groups Projects
Commit d83d40e7 authored by Thomas Jahns's avatar Thomas Jahns :cartwheel:
Browse files

doc: Fix missing parameter documentation.

parent be311160
No related branches found
No related tags found
No related merge requests found
......@@ -177,6 +177,8 @@ SymPrefix(memcrc_r)(uint32_t *state, const unsigned char *block, size_t block_le
/**
* Does endian-swapping prior to checksumming in case platform is big-endian
*
* @param state contains the check accumulator, should be initialized
* to a defined value like 0
* @param elems points to first first element with alignment elem_size
* @param num_elems number of elements to process
* @param elem_size size of each element in bytes
......
......@@ -92,7 +92,7 @@ void xt_idxlist_delete(Xt_idxlist idxlist);
* packed index list
*
* @remark You need to provide the same buffer for all related calls of
* xt_idxlist_get_pack_size , \ref xt_idxlist_pack and
* \ref xt_idxlist_get_pack_size , \ref xt_idxlist_pack and
* \ref xt_idxlist_unpack
*
* @see xt_idxlist_pack
......@@ -118,7 +118,7 @@ size_t xt_idxlist_get_pack_size(Xt_idxlist idxlist, MPI_Comm comm);
* index list. You can determine the required size using
* \ref xt_idxlist_get_pack_size .
* @remark You need to provide the same buffer for all related calls of
* \ref xt_idxlist_get_pack_size , xt_idxlist_pack and \ref xt_idxlist_unpack
* \ref xt_idxlist_get_pack_size , \ref xt_idxlist_pack and \ref xt_idxlist_unpack
*
* @see xt_idxlist_get_pack_size
* @see xt_idxlist_unpack
......
......@@ -61,6 +61,10 @@
* in this function
* @param ebuf points to memory of extra_buf_size chars, aligned like
* a data pointer
* @param data passes on the paramter of the same name to
* @ref xt_request_msgs_ebuf_new
*
* @param comm MPI communicator to use for error reporting
*/
typedef void (*Xt_fill_ebuf_requests)(Xt_request requests_msgs,
MPI_Request *requests,
......
......@@ -108,6 +108,10 @@ typedef struct Xt_com_list (*Xt_xmdd_bucket_gen_next)(
* be empty anyway). Any previously returned buckets become invalid.
* @param[in] get_intersect_max_num This function returns, for a given
* state the maximal number of buckets that will be generated
*
* @param gen_state_size number of bytes to allocate for each generator state
* @param init_params global parameters passed to each invocation of
* the \a init function
*/
void
xt_xmdd_bucket_gen_define_interface(
......
......@@ -106,6 +106,7 @@ xt_xmap_intersection_new(int num_src_intersections,
* @param[in] dst_idxlist destination index list
* @param[in] comm MPI communicator that contains all processes
* that part in the exchange
* @param[in] config custom configuration parameters
*/
Xt_xmap
xt_xmap_intersection_custom_new(
......
......@@ -105,6 +105,7 @@ xt_idxstripes_congeal(struct Xt_stripes_alloc stripes_alloc);
*
* @param[in] num_stripes number of stripes
* @param[in] stripes array defining the stripes
* @param[in] config custom configuration parameters
* @return index list composed of the stripes passed in
*/
PPM_DSO_INTERNAL Xt_idxlist
......
......@@ -176,6 +176,7 @@ xt_create_compound_datatype(size_t count,
* @param[in] redists redistribution objects
* @param[out] num_ranks number of incoming/outgoing messages per redist
* @param[out] ranks ranks of communicator partners for each redist
* @param[in] config custom configuration parameters
* @return Number of processes that receive data from/send data to the
* local process.
* @remark the user needs to ensure that rank arrays are big enough to hold all
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment