Merge pull request #8 from beyonddream/fix-header-comments

fix function decl comments in the header.

Author: beyonddream

snowid.h

@@ -51,22 +51,24 @@ typedef unsigned char snow_id_binary_t[16];
  * sequence_id is incremented as many times as the function is called within the
  * same timestamp.
  * 
- * @arg snowid - If able to generate an id, set the value of id to `snow_id`.
- * @return true if successfully able to generate an id, false if not.
+ * @param snowid - If able to generate an id, set the value of id to `snow_id`.
+ * @return bool - true if successfully able to generate an id, false if not.
  */
 bool snow_get_id(snow_id_t *snowid);
 
 /**
  * Dump snow state and config to stdout for debugging.
- * @arg stream - any file descriptor (stdout if NULL)
+ * 
+ * @param stream - any file descriptor (stdout if NULL)
+ * @return void
  */ 
 void snow_dump(FILE *stream);
 
 /**
  * Initializes the snowid engine with the config. It has to be called only once before
  * calling any other API functions.
  * 
- * @arg config - The snowid configuration
+ * @param config - The snowid configuration
  * @return void
  */
 void snow_init(snow_config_t *config);
@@ -75,7 +77,7 @@ void snow_init(snow_config_t *config);
  * Deinitializes the snowid engine. It has to be called only once at the end
  * and no other API functions should be called after it except snow_init().
  * 
- * @arg void
+ * @param void
  * @return void
  */
 void snow_shutdown(void);
@@ -86,7 +88,7 @@ void snow_shutdown(void);
  * <unix timestamp (64 bits) + MAC address (48 bits) + sequence number (16 bits)>
  * 
  * @param snowid_as_bin - set to snowid as binary
- * @return true if success, else false.
+ * @return bool - true if success, else false.
 */
 bool snow_get_id_as_binary(snow_id_binary_t snowid_as_bin);
 
@@ -95,6 +97,7 @@ bool snow_get_id_as_binary(snow_id_binary_t snowid_as_bin);
  * 
  * @param snowid_as_bin - set the converted snowid as binary
  * @param snowid - pass in already generated snowid
+ * @return bool - true if success, else false.
 */
 bool snow_id_convert(snow_id_binary_t snowid_as_bin, const snow_id_t *snowid);
 

snowid_checkpoint.h

@@ -27,6 +27,13 @@
 
 #include <stdbool.h>
 
+/**
+ * Start a child process to periodically save current time in `timestamp_path`
+ * location.
+ * 
+ * @param timestamp_path - filepath to store timestamp
+ * @return bool - true if success, else false.
+*/
 bool snow_checkpoint_start(char *timestamp_path);
 
 #endif /* __SNOWID_CHECKPOINT_H__ */

snowid_util.h

@@ -35,13 +35,15 @@
  * 
  * @param workerid Binary representation of the mac address of the interface.
  * @param interface Interface name to pull the address from.
- * @return success if we could set a workerid, else failure.
+ * @return bool - true if we could return hw address, else false.
  */
 bool get_hw_addr_as_binary(uint64_t *workerid, char *interface);
 
 /**
+ * Get current timestamp
+ * 
  * @param result - set the current timestamp to the value pointed by result.
- * @return true if success else false.
+ * @return bool - true if we can get current timestamp, else false.
 */
 bool get_current_ts(uint64_t *result);