Open
Description
The osc.h header file has outdated doxygen comments that don't properly explain each of the parameters. For example:
/**
* OSC component query
*
* Query whether, given the info and comm, the component can be used
* for one-sided support. The ability to use the component for the
* window does not mean that the component will be selected. The win
* argument should not be modified during this call and no memory
* should be allocated that is associated with this window.
*
* @return The selection priority of the component
*
* @param[in] win The window handle, already filled in by MPI_WIN_CREATE()
* @param[in] info An info structure with hints from the user
* regarding the usage of the component
* @param[in] comm The communicator specified by the user for the
* basis of the group membership for the Window.
*
* @retval -1 The component can not be used for this window
* @retval >= 0 The priority of the component for this window
*/
typedef int (*ompi_osc_base_component_query_fn_t)(struct ompi_win_t *win,
void **base,
size_t size,
int disp_unit,
struct ompi_communicator_t *comm,
struct opal_info_t *info,
int flavor);
Base, size, disp_unit, and flavor of this API are not defined.
All the module functions also do not have comments either which makes understanding them harder.