summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Juyung Seo <seojuyung2@gmail.com>2012-08-15 04:32:05 +0000
committerDaniel Juyung Seo <seojuyung2@gmail.com>2012-08-15 04:32:05 +0000
commitf9183e2ca840b1f06eb740c8d304aa3c031ed69d (patch)
tree3aee0a32e693a7a74bf3dcfa3e283a8642c02b56
parent9ae85c94b3f3fedd9d01609afa3e83b3bff70bd4 (diff)
eina: Use more @note notation. Fixed more wrong documentation.
SVN revision: 75280
-rw-r--r--src/include/eina_binshare.h10
-rw-r--r--src/include/eina_counter.h2
-rw-r--r--src/include/eina_matrixsparse.h12
-rw-r--r--src/include/eina_stringshare.h7
-rw-r--r--src/include/eina_ustringshare.h11
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);
135 * @p obj is freed. If @p obj is @c NULL, the function returns 135 * @p obj is freed. If @p obj is @c NULL, the function returns
136 * immediately. 136 * immediately.
137 * 137 *
138 * Note that if the given pointer is not shared or NULL, bad things 138 * @note If the given pointer is not shared, bad things will happen, likely a
139 * will happen, likely a segmentation fault. 139 * segmentation fault.
140 */ 140 */
141EAPI void eina_binshare_del(const void *obj); 141EAPI void eina_binshare_del(const void *obj);
142 142
@@ -148,9 +148,9 @@ EAPI void eina_binshare_del(const void *obj);
148 * @return The length of the shared object. 148 * @return The length of the shared object.
149 * 149 *
150 * This function is a cheap way to known the length of a shared 150 * This function is a cheap way to known the length of a shared
151 * object. Note that if the given pointer is not shared, bad 151 * object.
152 * things will happen, likely a segmentation fault. If in doubt, try 152 * @note If the given pointer is not shared, bad things will happen, likely a
153 * strlen(). 153 * segmentation fault. If in doubt, try strlen().
154 */ 154 */
155EAPI int eina_binshare_length(const void *obj) EINA_WARN_UNUSED_RESULT; 155EAPI int eina_binshare_length(const void *obj) EINA_WARN_UNUSED_RESULT;
156 156
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 @@
99 * 1 9794125 783816 10577941 99 * 1 9794125 783816 10577941
100 * @endverbatim 100 * @endverbatim
101 * 101 *
102 * Note that the displayed time is in nanosecond. 102 * @note The displayed time is in nanosecond.
103 */ 103 */
104 104
105/** 105/**
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
317 * 317 *
318 * @warning cells, rows or columns are not reference counted and thus 318 * @warning cells, rows or columns are not reference counted and thus
319 * after this call any reference might be invalid if instance were 319 * after this call any reference might be invalid if instance were
320 * freed. Note that this call might delete container column and 320 * freed.
321 * row if this cell was the last remainder. 321 *
322 * @note This call might delete container column and row if this cell was the
323 * last remainder.
322 */ 324 */
323EAPI Eina_Bool eina_matrixsparse_cell_idx_clear(Eina_Matrixsparse *m, unsigned long row, unsigned long col); 325EAPI Eina_Bool eina_matrixsparse_cell_idx_clear(Eina_Matrixsparse *m, unsigned long row, unsigned long col);
324 326
@@ -331,8 +333,10 @@ EAPI Eina_Bool eina_matrixsparse_cell_idx_clear(Eina_Matrixsparse *m, unsigned l
331 * 333 *
332 * @warning cells, rows or columns are not reference counted and thus 334 * @warning cells, rows or columns are not reference counted and thus
333 * after this call any reference might be invalid if instance were 335 * after this call any reference might be invalid if instance were
334 * freed. Note that this call might delete container column and 336 * freed.
335 * row if this cell was the last remainder. 337 *
338 * @note This call might delete container column and row if this cell was the
339 * last remainder.
336 */ 340 */
337EAPI Eina_Bool eina_matrixsparse_cell_clear(Eina_Matrixsparse_Cell *cell); 341EAPI Eina_Bool eina_matrixsparse_cell_clear(Eina_Matrixsparse_Cell *cell);
338 342
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);
315 * @return The length of a shared string. 315 * @return The length of a shared string.
316 * 316 *
317 * This function is a cheap way to known the length of a shared 317 * This function is a cheap way to known the length of a shared
318 * string. Note that if the given pointer is not shared, bad 318 * string.
319 * things will happen, likely a segmentation fault. If in doubt, try 319 *
320 * strlen(). 320 * @note If the given pointer is not shared, bad things will happen, likely a
321 * segmentation fault. If in doubt, try strlen().
321 */ 322 */
322EAPI int eina_stringshare_strlen(Eina_Stringshare *str) EINA_PURE EINA_WARN_UNUSED_RESULT; 323EAPI int eina_stringshare_strlen(Eina_Stringshare *str) EINA_PURE EINA_WARN_UNUSED_RESULT;
323 324
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);
158 * @p str is freed. If @p str is @c NULL, the function returns 158 * @p str is freed. If @p str is @c NULL, the function returns
159 * immediately. 159 * immediately.
160 * 160 *
161 * Note that if the given pointer is not shared or @c NULL, bad things 161 * @note If the given pointer is not shared, bad things will happen, likely a
162 * will happen, likely a segmentation fault. 162 * segmentation fault.
163 */ 163 */
164EAPI void eina_ustringshare_del(const Eina_Unicode *str); 164EAPI void eina_ustringshare_del(const Eina_Unicode *str);
165 165
@@ -170,9 +170,10 @@ EAPI void eina_ustringshare_del(const Eina_Unicode *str);
170 * give @c NULL, in that case @c -1 is returned. 170 * give @c NULL, in that case @c -1 is returned.
171 * 171 *
172 * This function is a cheap way to known the length of a shared 172 * This function is a cheap way to known the length of a shared
173 * string. Note that if the given pointer is not shared, bad 173 * string.
174 * things will happen, likely a segmentation fault. If in doubt, try 174 *
175 * strlen(). 175 * @note If the given pointer is not shared, bad things will happen, likely a
176 * segmentation fault. If in doubt, try strlen().
176 */ 177 */
177EAPI int eina_ustringshare_strlen(const Eina_Unicode *str) EINA_PURE EINA_WARN_UNUSED_RESULT; 178EAPI int eina_ustringshare_strlen(const Eina_Unicode *str) EINA_PURE EINA_WARN_UNUSED_RESULT;
178 179