Browse Source

* Minor documentation fix.

tags/v0.99.beta14
Sam Hocevar sam 18 years ago
parent
commit
b1bf22a593
1 changed files with 2 additions and 1 deletions
  1. +2
    -1
      cucul/frame.c

+ 2
- 1
cucul/frame.c View File

@@ -90,13 +90,14 @@ char const *cucul_get_frame_name(cucul_canvas_t *cv)
/** \brief Set the current frame's name. /** \brief Set the current frame's name.
* *
* Set the current frame's name. Upon creation, a frame has a default name * Set the current frame's name. Upon creation, a frame has a default name
* of \rc "frame#xxxxxxxx" where \c xxxxxxxx is a self-incrementing
* of \c "frame#xxxxxxxx" where \c xxxxxxxx is a self-incrementing
* hexadecimal number. * hexadecimal number.
* *
* If an error occurs, -1 is returned and \b errno is set accordingly: * If an error occurs, -1 is returned and \b errno is set accordingly:
* - \c ENOMEM Not enough memory to allocate new frame. * - \c ENOMEM Not enough memory to allocate new frame.
* *
* \param cv A libcucul canvas. * \param cv A libcucul canvas.
* \param name The name to give to the current frame.
* \return 0 in case of success, -1 if an error occurred. * \return 0 in case of success, -1 if an error occurred.
*/ */
int cucul_set_frame_name(cucul_canvas_t *cv, char const *name) int cucul_set_frame_name(cucul_canvas_t *cv, char const *name)


Loading…
Cancel
Save