From f9183e2ca840b1f06eb740c8d304aa3c031ed69d Mon Sep 17 00:00:00 2001 From: Daniel Juyung Seo Date: Wed, 15 Aug 2012 04:32:05 +0000 Subject: eina: Use more @note notation. Fixed more wrong documentation. SVN revision: 75280 --- src/include/eina_binshare.h | 10 +++++----- src/include/eina_counter.h | 2 +- src/include/eina_matrixsparse.h | 12 ++++++++---- src/include/eina_stringshare.h | 7 ++++--- src/include/eina_ustringshare.h | 11 ++++++----- 5 files changed, 24 insertions(+), 18 deletions(-) diff --git a/src/include/eina_binshare.h b/src/include/eina_binshare.h index e23f046..5a4488d 100644 --- a/src/include/eina_binshare.h +++ b/src/include/eina_binshare.h @@ -135,8 +135,8 @@ EAPI const void *eina_binshare_ref(const void *obj); * @p obj is freed. If @p obj is @c NULL, the function returns * immediately. * - * Note that if the given pointer is not shared or NULL, bad things - * will happen, likely a segmentation fault. + * @note If the given pointer is not shared, bad things will happen, likely a + * segmentation fault. */ EAPI void eina_binshare_del(const void *obj); @@ -148,9 +148,9 @@ EAPI void eina_binshare_del(const void *obj); * @return The length of the shared object. * * This function is a cheap way to known the length of a shared - * object. Note that if the given pointer is not shared, bad - * things will happen, likely a segmentation fault. If in doubt, try - * strlen(). + * object. + * @note If the given pointer is not shared, bad things will happen, likely a + * segmentation fault. If in doubt, try strlen(). */ EAPI int eina_binshare_length(const void *obj) EINA_WARN_UNUSED_RESULT; diff --git a/src/include/eina_counter.h b/src/include/eina_counter.h index 26bee06..677d97e 100644 --- a/src/include/eina_counter.h +++ b/src/include/eina_counter.h @@ -99,7 +99,7 @@ * 1 9794125 783816 10577941 * @endverbatim * - * Note that the displayed time is in nanosecond. + * @note The displayed time is in nanosecond. */ /** diff --git a/src/include/eina_matrixsparse.h b/src/include/eina_matrixsparse.h index 8f8db4f..e7db606 100644 --- a/src/include/eina_matrixsparse.h +++ b/src/include/eina_matrixsparse.h @@ -317,8 +317,10 @@ EAPI Eina_Bool eina_matrixsparse_column_idx_clear(Eina_Matrixsparse *m, unsigned * * @warning cells, rows or columns are not reference counted and thus * after this call any reference might be invalid if instance were - * freed. Note that this call might delete container column and - * row if this cell was the last remainder. + * freed. + * + * @note This call might delete container column and row if this cell was the + * last remainder. */ EAPI Eina_Bool eina_matrixsparse_cell_idx_clear(Eina_Matrixsparse *m, unsigned long row, unsigned long col); @@ -331,8 +333,10 @@ EAPI Eina_Bool eina_matrixsparse_cell_idx_clear(Eina_Matrixsparse *m, unsigned l * * @warning cells, rows or columns are not reference counted and thus * after this call any reference might be invalid if instance were - * freed. Note that this call might delete container column and - * row if this cell was the last remainder. + * freed. + * + * @note This call might delete container column and row if this cell was the + * last remainder. */ EAPI Eina_Bool eina_matrixsparse_cell_clear(Eina_Matrixsparse_Cell *cell); diff --git a/src/include/eina_stringshare.h b/src/include/eina_stringshare.h index c010e07..9a05bcd 100644 --- a/src/include/eina_stringshare.h +++ b/src/include/eina_stringshare.h @@ -315,9 +315,10 @@ EAPI void eina_stringshare_del(Eina_Stringshare *str); * @return The length of a shared string. * * This function is a cheap way to known the length of a shared - * string. Note that if the given pointer is not shared, bad - * things will happen, likely a segmentation fault. If in doubt, try - * strlen(). + * string. + * + * @note If the given pointer is not shared, bad things will happen, likely a + * segmentation fault. If in doubt, try strlen(). */ EAPI int eina_stringshare_strlen(Eina_Stringshare *str) EINA_PURE EINA_WARN_UNUSED_RESULT; diff --git a/src/include/eina_ustringshare.h b/src/include/eina_ustringshare.h index 60388e4..f97f305 100644 --- a/src/include/eina_ustringshare.h +++ b/src/include/eina_ustringshare.h @@ -158,8 +158,8 @@ EAPI const Eina_Unicode *eina_ustringshare_ref(const Eina_Unicode *str); * @p str is freed. If @p str is @c NULL, the function returns * immediately. * - * Note that if the given pointer is not shared or @c NULL, bad things - * will happen, likely a segmentation fault. + * @note If the given pointer is not shared, bad things will happen, likely a + * segmentation fault. */ EAPI void eina_ustringshare_del(const Eina_Unicode *str); @@ -170,9 +170,10 @@ EAPI void eina_ustringshare_del(const Eina_Unicode *str); * give @c NULL, in that case @c -1 is returned. * * This function is a cheap way to known the length of a shared - * string. Note that if the given pointer is not shared, bad - * things will happen, likely a segmentation fault. If in doubt, try - * strlen(). + * string. + * + * @note If the given pointer is not shared, bad things will happen, likely a + * segmentation fault. If in doubt, try strlen(). */ EAPI int eina_ustringshare_strlen(const Eina_Unicode *str) EINA_PURE EINA_WARN_UNUSED_RESULT; -- cgit v1.2.1