diff options
Diffstat (limited to '')
| -rw-r--r-- | libgamma_quartz_cg_site_initialise.c | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/libgamma_quartz_cg_site_initialise.c b/libgamma_quartz_cg_site_initialise.c index cc47e3a..c842629 100644 --- a/libgamma_quartz_cg_site_initialise.c +++ b/libgamma_quartz_cg_site_initialise.c @@ -6,15 +6,15 @@ /** * Initialise an allocated site state * - * @param this The site state to initialise - * @param site The site identifier, unless it is `NULL` it must a - * `free`:able. Once the state is destroyed the library - * will attempt to free it. There you should not free - * it yourself, and it must not be a string constant - * or allocate on the stack. Note however that it will - * not be free:d if this function fails. - * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * @param this The site state to initialise + * @param site The site identifier, unless it is `NULL` it must a + * `free`:able. Once the state is destroyed the library + * will attempt to free it. There you should not free + * it yourself, and it must not be a string constant + * or allocate on the stack. Note however that it will + * not be free:d if this function fails. + * @return Zero on success, otherwise (negative) the value of an + * error identifier provided by this library */ int libgamma_quartz_cg_site_initialise(struct libgamma_site_state *restrict this, char *restrict site) |