Ignore:
Timestamp:
Oct 26, 2006, 12:06:21 AM (13 years ago)
Author:
Sam Hocevar
Message:
  • Removed "This function..." constructs from documentation. Fixed a few documentation errors or imprecisions.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • libcaca/trunk/cucul/buffer.c

    r1048 r1231  
    3030/** \brief Load a memory area into a buffer.
    3131 *
    32  *  This function creates a \e libcucul buffer that points to the given
    33  *  memory area. The data is not duplicated and any changes made to the
    34  *  original memory area appear in the buffer.
     32 *  Create a \e libcucul buffer that points to the given memory area. The
     33 *  data is not duplicated and any changes made to the original memory area
     34 *  will appear in the buffer.
    3535 *
    3636 *  \param data The memory area to load.
     
    5656/** \brief Load a file into a buffer.
    5757 *
    58  *  This function loads a file into memory and returns a \e libcucul buffer
    59  *  for use with other functions.
     58 *  Load a file into memory and returns a \e libcucul buffer for use with
     59 *  other functions.
    6060 *
    6161 *  \param file The filename
     
    103103/** \brief Get the buffer size.
    104104 *
    105  *  This function returns the length (in bytes) of the memory area stored
    106  *  in the given \e libcucul buffer.
     105 *  Return the length (in bytes) of the memory area stored in the given
     106 *  \e libcucul buffer.
    107107 *
    108108 *  This function never fails.
     
    118118/** \brief Get the buffer data.
    119119 *
    120  *  This function returns a pointer to the memory area stored in the given
     120 *  Get a pointer to the memory area stored in the given
    121121 *  \e libcucul buffer.
    122122 *
     
    133133/** \brief Free a buffer.
    134134 *
    135  *  This function frees the structures associated with the given
    136  *  \e libcucul buffer.
     135 *  Free the structures associated with the given \e libcucul buffer.
    137136 *
    138137 *  This function never fails.
Note: See TracChangeset for help on using the changeset viewer.