PUD: fix some comments
authorFerry Huberts <f.huberts@mindef.nl>
Wed, 26 Oct 2011 13:42:59 +0000 (15:42 +0200)
committerFerry Huberts <ferry.huberts@pelagic.nl>
Tue, 14 Feb 2012 13:32:58 +0000 (14:32 +0100)
Signed-off-by: Ferry Huberts <f.huberts@mindef.nl>
lib/pud/src/configuration.c

index 58fc6c1..80db4b5 100644 (file)
@@ -294,6 +294,10 @@ int setNodeId(const char *value, void *data __attribute__ ((unused)), set_plugin
  the maximum value
  @param bytes
  the number of bytes in the buffer
+
+ @return
+ - true when ok
+ - false on failure
  */
 static bool setupNodeIdBinaryLongLong(unsigned long long min,
                unsigned long long max, unsigned int bytes) {
@@ -321,6 +325,10 @@ static bool setupNodeIdBinaryLongLong(unsigned long long min,
 /**
  Validate whether the configured nodeId is valid w.r.t. the configured
  nodeIdType, for types that are strings
+
+ @return
+ - true when ok
+ - false on failure
  */
 static bool setupNodeIdBinaryString(void) {
        bool invalidChars;