Context Navigation

-              rfc3680e
+              r087c8798
  * @{
  */
 /** @file
+/** @file Standard library definitions.
  */
 …
 /**
+ * Integer absolute value.
+ *
  * @param i Input value.
 …
 /**
+ * Long integer absolute value.
+ *
  * @param i Input value.
 …
 /**
+ * Long long integer absolute value.
+ *
  * @param i Input value.
 …
+}
+/**
+ * Compute the quotient and remainder of an integer division.
+ *
+ * @param numer Numerator.
+ * @param denom Denominator.
+ * @return Quotient and remainder packed into structure.
+ */
 posix_div_t posix_div(int numer, int denom)
+{
 …
+}
+/**
+ * Compute the quotient and remainder of a long integer division.
+ *
+ * @param numer Numerator.
+ * @param denom Denominator.
+ * @return Quotient and remainder packed into structure.
+ */
 posix_ldiv_t posix_ldiv(long numer, long denom)
+{
 …
+}
+/**
+ * Compute the quotient and remainder of a long long integer division.
+ *
+ * @param numer Numerator.
+ * @param denom Denominator.
+ * @return Quotient and remainder packed into structure.
+ */
 posix_lldiv_t posix_lldiv(long long numer, long long denom)
+{
 …
  * @param elem2 Second element to compare.
  * @param compare Comparison function without userdata parameter.
+ *
  * @return Relative ordering of the elements.
  */
 …
  * Array sorting utilizing the quicksort algorithm.
+ *
  * @param array
  * @param count
  * @param size
  * @param compare
+ * @param array Array of elements to sort.
+ * @param count Number of elements in the array.
+ * @param size Width of each element.
+ * @param compare Decides relative ordering of two elements.
  */
 void posix_qsort(void *array, size_t count, size_t size,
 …
 /**
  * Retrieve a value of the given environment variable.
+ *
  * Since HelenOS doesn't support env variables at the moment,
  * this function always returns NULL.
+ *
  * @param name
  * @return Always NULL.
+ * @param name Name of the variable.
+ * @return Value of the variable or NULL if such variable does not exist.
  */
 char *posix_getenv(const char *name)
 …
 /**
+ *
+ * @param string String to be passed to a command interpreter.
+ * @return
+ * Issue a command.
+ *
+ * @param string String to be passed to a command interpreter or NULL.
+ * @return Termination status of the command if the command is not NULL,
+ *     otherwise indicate whether there is a command interpreter (non-zero)
+ *     or not (zero).
  */
 int posix_system(const char *string) {
 …
 /**
+ *
+ * @param name
+ * @param resolved
+ * @return
+ */
+char *posix_realpath(const char *name, char *resolved)
+ * Resolve absolute pathname.
+ *
+ * @param name Pathname to be resolved.
+ * @param resolved Either buffer for the resolved absolute pathname or NULL.
+ * @return On success, either resolved (if it was not NULL) or pointer to the
+ *     newly allocated buffer containing the absolute pathname (if resolved was
+ *     NULL). Otherwise NULL.
+ *
+ */
+char *posix_realpath(const char *restrict name, char *restrict resolved)
+{
         #ifndef PATH_MAX
 …
  * its native representation. See posix_strtold().
+ *
  * @param nptr
  * @return
+ * @param nptr String representation of a floating-point number.
+ * @return Double-precision number resulting from the string conversion.
  */
 double posix_atof(const char *nptr)
 …
  * its native representation. See posix_strtold().
+ *
+ * @param nptr
+ * @param endptr
+ * @return
+ * @param nptr String representation of a floating-point number.
+ * @param endptr Pointer to the final part of the string which
+ *     was not used for conversion.
+ * @return Single-precision number resulting from the string conversion.
  */
 float posix_strtof(const char *restrict nptr, char **restrict endptr)
 …
  * its native representation. See posix_strtold().
+ *
+ * @param nptr
+ * @param endptr
+ * @return
+ * @param nptr String representation of a floating-point number.
+ * @param endptr Pointer to the final part of the string which
+ *     was not used for conversion.
+ * @return Double-precision number resulting from the string conversion.
  */
 double posix_strtod(const char *restrict nptr, char **restrict endptr)
 …
 /**
+ *
+ * @param size
+ * @return
+ * Allocate memory chunk.
+ *
+ * @param size Size of the chunk to allocate.
+ * @return Either pointer to the allocated chunk or NULL if not possible.
  */
 void *posix_malloc(size_t size)
 …
 /**
+ *
+ * @param nelem
+ * @param elsize
+ * @return
+ * Allocate memory for an array of elements.
+ *
+ * @param nelem Number of elements in the array.
+ * @param elsize Size of each element.
+ * @return Either pointer to the allocated array or NULL if not possible.
  */
 void *posix_calloc(size_t nelem, size_t elsize)
 …
 /**
+ *
+ * @param ptr
+ * @param size
+ * @return
+ * Reallocate memory chunk to a new size.
+ *
+ * @param ptr Memory chunk to reallocate. Might be NULL.
+ * @param size Size of the reallocated chunk. Might be zero.
+ * @return Either NULL or the pointer to the newly reallocated chunk.
  */
 void *posix_realloc(void *ptr, size_t size)
 …
 /**
+ *
+ * @param ptr
+ * Free allocated memory chunk.
+ *
+ * @param ptr Memory chunk to be freed.
  */
 void posix_free(void *ptr)
 …
 /**
+ * Should read system load statistics. Not supported. Always returns -1.
+ *
+ * @param loadavg
+ * @param nelem
+ * @return
+ * Get system load average statistics.
+ *
+ * Not supported. Always returns -1.
+ *
+ * @param loadavg Array where the load averages shall be placed.
+ * @param nelem Maximum number of elements to be placed into the array.
+ * @return Number of elements placed into the array on success, -1 otherwise.
  */
 int bsd_getloadavg(double loadavg[], int nelem)

Note: See TracChangeset for help on using the changeset viewer.

Context Navigation

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

Legend:

uspace/lib/posix/stdlib.c

Download in other formats: