[Groonga-commit] groonga/groonga at 8bbf5d5 [master] doc: move all the rest of grn_table_cursor_*() document from groonga.h to Sphinx text

Back to archive index

whombx null+****@clear*****
Wed Aug 7 21:21:47 JST 2013


whombx	2013-08-07 21:21:47 +0900 (Wed, 07 Aug 2013)

  New Revision: 8bbf5d5c3acacc145aa0f47bd86953a14415265d
  https://github.com/groonga/groonga/commit/8bbf5d5c3acacc145aa0f47bd86953a14415265d

  Merged 13fc3b8: Merge pull request #74 from whombx/grn-table-cursor-close

  Message:
    doc: move all the rest of grn_table_cursor_*() document from groonga.h to Sphinx text

  Modified files:
    doc/source/reference/api/grn_table_cursor.txt
    include/groonga.h

  Modified: doc/source/reference/api/grn_table_cursor.txt (+45 -0)
===================================================================
--- doc/source/reference/api/grn_table_cursor.txt    2013-08-07 13:46:53 +0900 (18ca854)
+++ doc/source/reference/api/grn_table_cursor.txt    2013-08-07 21:21:47 +0900 (4a09592)
@@ -62,3 +62,48 @@ Reference
 
       ``GRN_CURSOR_PREFIX`` を指定したときは-1より小さい負の数を指定することはできません。
 
+.. c:function:: grn_rc grn_table_cursor_close(grn_ctx *ctx, grn_table_cursor *tc)
+
+   :c:func:`grn_table_cursor_open` で生成したcursorを解放します。
+
+   :param tc: 対象cursorを指定します。
+
+.. c:function:: grn_id grn_table_cursor_next(grn_ctx *ctx, grn_table_cursor *tc)
+
+   cursorのカレントレコードを一件進めてそのIDを返します。cursorの対象範囲の末尾に達すると ``GRN_ID_NIL`` を返します。
+
+   :param tc: 対象cursorを指定します。
+
+.. c:function:: int grn_table_cursor_get_key(grn_ctx *ctx, grn_table_cursor *tc, void **key)
+
+   cursorのカレントレコードのkeyをkeyパラメータにセットし、その長さを返します。
+
+   :param tc: 対象cursorを指定します。
+   :param key: カレントレコードのkeyへのポインタがセットされます。
+
+.. c:function:: int grn_table_cursor_get_value(grn_ctx *ctx, grn_table_cursor *tc, void **value)
+
+   cursorパラメータのカレントレコードのvalueをvalueパラメータにセットし、その長さを返します。
+
+   :param tc: 対象cursorを指定します。
+   :param value: カレントレコードのvalueへのポインタがセットされます。
+
+.. c:function:: grn_rc grn_table_cursor_set_value(grn_ctx *ctx, grn_table_cursor *tc, const void *value, int flags)
+
+   cursorのカレントレコードのvalueを引数の内容に置き換えます。cursorのカレントレコードが存在しない場合は ``GRN_INVALID_ARGUMENT`` を返します。
+
+   :param tc: 対象cursorを指定します。
+   :param value: 新しいvalueの値を指定します。
+   :param flags: :c:func:`grn_obj_set_value()` のflagsと同様の値を指定できます。
+
+.. c:function:: grn_rc grn_table_cursor_delete(grn_ctx *ctx, grn_table_cursor *tc)
+
+   cursorのカレントレコードを削除します。cursorのカレントレコードが存在しない場合は ``GRN_INVALID_ARGUMENT`` を返します。
+
+   :param tc: 対象cursorを指定します。
+
+.. c:function:: grn_obj *grn_table_cursor_table(grn_ctx *ctx, grn_table_cursor *tc)
+
+   cursorが属するtableを返します。
+
+   :param tc: 対象cursorを指定します。

  Modified: include/groonga.h (+0 -54)
===================================================================
--- include/groonga.h    2013-08-07 13:46:53 +0900 (9438149)
+++ include/groonga.h    2013-08-07 21:21:47 +0900 (22d5ada)
@@ -743,67 +743,13 @@ GRN_API grn_table_cursor *grn_table_cursor_open(grn_ctx *ctx, grn_obj *table,
                                                 const void *min, unsigned int min_size,
                                                 const void *max, unsigned int max_size,
                                                 int offset, int limit, int flags);
-
-/**
- * grn_table_cursor_close:
- * @tc: 対象cursor
- *
- * grn_table_cursor_openで生成したcursorを解放する。
- **/
 GRN_API grn_rc grn_table_cursor_close(grn_ctx *ctx, grn_table_cursor *tc);
-
-/**
- * grn_table_cursor_next:
- * @tc: 対象cursor
- *
- * cursorのカレントレコードを一件進めてそのIDを返す。
- * cursorの対象範囲の末尾に達するとGRN_ID_NILを返す。
- **/
 GRN_API grn_id grn_table_cursor_next(grn_ctx *ctx, grn_table_cursor *tc);
-
-/**
- * grn_table_cursor_get_key:
- * @tc: 対象cursor
- * @key: カレントレコードのkeyへのポインタがセットされる。
- * cursorのカレントレコードのkeyを@keyにセットし、その長さを返す。
- **/
 GRN_API int grn_table_cursor_get_key(grn_ctx *ctx, grn_table_cursor *tc, void **key);
-
-/**
- * grn_table_cursor_get_value:
- * @tc: 対象cursor
- * @value: カレントレコードのvalueへのポインタがセットされる。
- * cursorのカレントレコードのvalueを@valueにセットし、その長さを返す。
- **/
 GRN_API int grn_table_cursor_get_value(grn_ctx *ctx, grn_table_cursor *tc, void **value);
-
-/**
- * grn_table_cursor_set_value:
- * @tc: 対象cursor
- * @value: 新しいvalueの値。
- * @flags: grn_obj_set_valueのflagsと同様の値を指定できる。
- *
- * cursorのカレントレコードのvalueを引数の内容に置き換える。
- * cursorのカレントレコードが存在しない場合はGRN_INVALID_ARGUMENTを返す。
- **/
 GRN_API grn_rc grn_table_cursor_set_value(grn_ctx *ctx, grn_table_cursor *tc,
                                           const void *value, int flags);
-
-/**
- * grn_table_cursor_delete:
- * @tc: 対象cursor
- *
- * cursorのカレントレコードを削除する。
- * cursorのカレントレコードが存在しない場合はGRN_INVALID_ARGUMENTを返す。
- **/
 GRN_API grn_rc grn_table_cursor_delete(grn_ctx *ctx, grn_table_cursor *tc);
-
-/**
- * grn_table_cursor_table:
- * @tc: 対象cursor
- *
- * cursorが属するtableを返す。
- **/
 GRN_API grn_obj *grn_table_cursor_table(grn_ctx *ctx, grn_table_cursor *tc);
 
 typedef struct {
-------------- next part --------------
HTML����������������������������...
Download 



More information about the Groonga-commit mailing list
Back to archive index