Move documentation from function declarations to definitions

Uses a perl script to move it (scripts/movedocs.pl)
This commit is contained in:
ZyX
2014-05-10 00:53:36 +04:00
committed by Thiago de Arruda
parent 52a9a5b0b0
commit 880957ad4e
37 changed files with 1064 additions and 885 deletions

View File

@@ -15,6 +15,10 @@ typedef struct {
static HandleData *init(uv_handle_t *handle);
/// Gets the RStream instance associated with a libuv handle
///
/// @param handle libuv handle
/// @return the RStream pointer
RStream *handle_get_rstream(uv_handle_t *handle)
{
RStream *rv = init(handle)->rstream;
@@ -22,11 +26,19 @@ RStream *handle_get_rstream(uv_handle_t *handle)
return rv;
}
/// Associates a RStream instance with a libuv handle
///
/// @param handle libuv handle
/// @param rstream the RStream pointer
void handle_set_rstream(uv_handle_t *handle, RStream *rstream)
{
init(handle)->rstream = rstream;
}
/// Gets the WStream instance associated with a libuv handle
///
/// @param handle libuv handle
/// @return the WStream pointer
WStream *handle_get_wstream(uv_handle_t *handle)
{
WStream *rv = init(handle)->wstream;
@@ -34,12 +46,20 @@ WStream *handle_get_wstream(uv_handle_t *handle)
return rv;
}
/// Associates a WStream instance with a libuv handle
///
/// @param handle libuv handle
/// @param wstream the WStream pointer
void handle_set_wstream(uv_handle_t *handle, WStream *wstream)
{
HandleData *data = init(handle);
data->wstream = wstream;
}
/// Gets the Job instance associated with a libuv handle
///
/// @param handle libuv handle
/// @return the Job pointer
Job *handle_get_job(uv_handle_t *handle)
{
Job *rv = init(handle)->job;
@@ -47,6 +67,10 @@ Job *handle_get_job(uv_handle_t *handle)
return rv;
}
/// Associates a Job instance with a libuv handle
///
/// @param handle libuv handle
/// @param job the Job pointer
void handle_set_job(uv_handle_t *handle, Job *job)
{
init(handle)->job = job;