From: Dan Mick Date: Sat, 8 Jun 2013 05:50:09 +0000 (-0700) Subject: librados.h: Fix up some doxygen problems X-Git-Tag: v0.65~125 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=00eaf97db099a9204856f31c88beccd53f56de0e;p=ceph.git librados.h: Fix up some doxygen problems Signed-off-by: Dan Mick --- diff --git a/src/include/rados/librados.h b/src/include/rados/librados.h index 98f4900927c..69eeccb323b 100644 --- a/src/include/rados/librados.h +++ b/src/include/rados/librados.h @@ -203,8 +203,10 @@ void rados_version(int *major, int *minor, int *extra); int rados_create(rados_t *cluster, const char * const id); /** + * Extended version of rados_create. + * * Like rados_create, but - * 1) don't assume 'client.'+id; allow full specification of name + * 1) don't assume 'client\.'+id; allow full specification of name * 2) allow specification of cluster name * 3) flags for future expansion */ @@ -1751,8 +1753,12 @@ int rados_pg_command(rados_t cluster, const char *pgstr, const char **cmd, char **outbuf, size_t *outbuflen, char **outs, size_t *outslen); -/** - * monitor cluster log +/* + * This is not a doxygen comment leadin, because doxygen breaks on + * a typedef with function params and returns, and I can't figure out + * how to fix it. + * + * Monitor cluster log * * Monitor events logged to the cluster log. The callback get each * log entry both as a single formatted line and with each field in a @@ -1765,6 +1771,7 @@ int rados_pg_command(rados_t cluster, const char *pgstr, const char **cmd, * @param level minimum log level (debug, info, warn|warning, err|error) * @param cb callback to run for each log message * @param arg void argument to pass to cb + * * @returns 0 on success, negative code on error */ typedef void (*rados_log_callback_t)(void *arg,