Changeset 087c8798 in mainline for uspace/lib/posix/stdlib/strtol.c

Timestamp:

2011-07-20T19:30:30Z (14 years ago)

Author:

Petr Koupy <petr.koupy@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

102a729

Parents:

fc3680e

Message:

Added comments to stdlib.h functions (no change in functionality).

File:

• uspace/lib/posix/stdlib/strtol.c (modified) (12 diffs)

uspace/lib/posix/stdlib/strtol.c

@@ -30 +30 @@
  * @{
  */
-/** @file
+/** @file Backend for integer conversions.
  */
 
@@ -42 +42 @@
 #include "../errno.h"
 
-// TODO: documentation
-
+/**
+ * Decides whether a digit belongs to a particular base.
+ *
+ * @param c Character representation of the digit.
+ * @param base Base against which the digit shall be tested.
+ * @return True if the digit belongs to the base, false otherwise.
+ */
 static inline bool is_digit_in_base(int c, int base)
 {
@@ -54 +59 @@
 }
 
+/**
+ * Derive a digit from its character representation.
+ *
+ * @param c Character representation of the digit.
+ * @param base Base into which the digit belongs to.
+ * @return Digit value represented by an integer.
+ */
 static inline int get_digit_in_base(int c, int base)
 {
@@ -63 +75 @@
 }
 
+/**
+ * Backend for all integer conversion functions. Can be configured by arguments
+ * to convert both signed and unsigned integers of various sizes.
+ *
+ * @param nptr Input string.
+ * @param endptr If non-NULL, *endptr is set to the position of the first
+ *     unrecognized character.
+ * @param base Expected base of the string representation.
+ * @param min_value Lower bound for the resulting conversion.
+ * @param max_value Upper bound for the resulting conversion.
+ * @param out_negative Either NULL for unsigned conversion or a pointer to the
+ *     bool variable into which shall be placed the negativity of the resulting
+ *     converted value.
+ * @return Result of the conversion.
+ */
 static inline unsigned long long internal_strtol(
     const char *restrict nptr, char **restrict endptr, int base,
@@ -188 +215 @@
 }
 
+/**
+ * Convert a string to an integer.
+ *
+ * @param nptr Input string.
+ * @return Result of the conversion.
+ */
 int posix_atoi(const char *nptr)
 {
@@ -197 +230 @@
 }
 
+/**
+ * Convert a string to a long integer.
+ *
+ * @param nptr Input string.
+ * @return Result of the conversion.
+ */
 long posix_atol(const char *nptr)
 {
@@ -206 +245 @@
 }
 
+/**
+ * Convert a string to a long long integer.
+ *
+ * @param nptr Input string.
+ * @return Result of the conversion.
+ */
 long long posix_atoll(const char *nptr)
 {
@@ -215 +260 @@
 }
 
+/**
+ * Convert a string to a long integer.
+ *
+ * @param nptr Input string.
+ * @param endptr Pointer to the final part of the string which
+ *     was not used for conversion.
+ * @param base Expected base of the string representation.
+ * @return Result of the conversion.
+ */
 long posix_strtol(const char *restrict nptr, char **restrict endptr, int base)
 {
@@ -224 +278 @@
 }
 
+/**
+ * Convert a string to a long long integer.
+ *
+ * @param nptr Input string.
+ * @param endptr Pointer to the final part of the string which
+ *     was not used for conversion.
+ * @param base Expected base of the string representation.
+ * @return Result of the conversion.
+ */
 long long posix_strtoll(
     const char *restrict nptr, char **restrict endptr, int base)
@@ -234 +297 @@
 }
 
+/**
+ * Convert a string to an unsigned long integer.
+ *
+ * @param nptr Input string.
+ * @param endptr Pointer to the final part of the string which
+ *     was not used for conversion.
+ * @param base Expected base of the string representation.
+ * @return Result of the conversion.
+ */
 unsigned long posix_strtoul(
     const char *restrict nptr, char **restrict endptr, int base)
@@ -243 +315 @@
 }
 
+/**
+ * Convert a string to a an unsigned long long integer.
+ *
+ * @param nptr Input string.
+ * @param endptr Pointer to the final part of the string which
+ *     was not used for conversion.
+ * @param base Expected base of the string representation.
+ * @return Result of the conversion.
+ */
 unsigned long long posix_strtoull(
     const char *restrict nptr, char **restrict endptr, int base)
@@ -249 +330 @@
 }
 
-
 /** @}
  */
-