[Nagios-checkins] SF.net SVN: nagios:[2074] nagioscore/trunk/lib

ageric at users.sourceforge.net ageric at users.sourceforge.net
Fri Aug 17 14:15:23 UTC 2012


Revision: 2074
          http://nagios.svn.sourceforge.net/nagios/?rev=2074&view=rev
Author:   ageric
Date:     2012-08-17 14:15:22 +0000 (Fri, 17 Aug 2012)
Log Message:
-----------
Fix doxygen errors in lib/kvvec.h and lib/iobroker.h

Since we're shipping a doxygen file we might as well make sure it
works as intended and without warnings.

Signed-off-by: Andreas Ericsson <ae at op5.se>

Modified Paths:
--------------
    nagioscore/trunk/lib/iobroker.h
    nagioscore/trunk/lib/kvvec.h

Modified: nagioscore/trunk/lib/iobroker.h
===================================================================
--- nagioscore/trunk/lib/iobroker.h	2012-08-17 12:08:26 UTC (rev 2073)
+++ nagioscore/trunk/lib/iobroker.h	2012-08-17 14:15:22 UTC (rev 2074)
@@ -85,7 +85,7 @@
 
 /**
  * Check if a particular filedescriptor is registered with the iobroker set
- * @param[in] The iobroker set the filedescriptor should be member of
+ * @param[in] iobs The iobroker set the filedescriptor should be member of
  * @param[in] fd The filedescriptor to check for
  * @return 1 if the filedescriptor is registered and 0 otherwise
  */

Modified: nagioscore/trunk/lib/kvvec.h
===================================================================
--- nagioscore/trunk/lib/kvvec.h	2012-08-17 12:08:26 UTC (rev 2073)
+++ nagioscore/trunk/lib/kvvec.h	2012-08-17 14:15:22 UTC (rev 2074)
@@ -60,6 +60,7 @@
 /**
  * Initialize a previously allocated key/value vector
  *
+ * @param kvv The key/value vector to initialize
  * @param hint Number of key/value pairs we expect to store
  * @return Pointer to a struct kvvec, properly initialized
  */
@@ -169,6 +170,7 @@
  * @param len Length of buffer to convert
  * @param kvsep Character separating key and value
  * @param pair_sep Character separating key/value pairs
+ * @param flags bitmask. See KVVEC_{ASSIGN,COPY,APPEND} for values
  * @return The created key/value vector
  */
 extern struct kvvec *buf2kvvec(char *str, unsigned int len, const char kvsep, const char pair_sep, int flags);
@@ -177,10 +179,12 @@
  * Parse a buffer into the pre-allocated key/value vector. Immensely
  * useful for ipc in combination with kvvec2buf().
  *
+ * @param kvv A pre-allocated key/value vector to populate
  * @param str The buffer to convert to a key/value vector
  * @param len Length of buffer to convert
  * @param kvsep Character separating key and value
  * @param pair_sep Character separating key/value pairs
+ * @param flags bitmask. See KVVEC_{ASSIGN,COPY,APPEND} for values
  * @return The number of pairs in the created key/value vector
  */
 extern int buf2kvvec_prealloc(struct kvvec *kvv, char *str, unsigned int len, const char kvsep, const char pair_sep, int flags);

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.





More information about the Nagios-commits mailing list