[Groonga-commit] groonga/groonga at bbeea08 [master] doc: move grn_table_size() and grn_table_rename() documents from groonga.h to Sphinx text

Back to archive index

whombx null+****@clear*****
Fri Aug 9 17:08:40 JST 2013


whombx	2013-08-09 17:08:40 +0900 (Fri, 09 Aug 2013)

  New Revision: bbeea087834767e86c38d062e2ae7ab8d74673d0
  https://github.com/groonga/groonga/commit/bbeea087834767e86c38d062e2ae7ab8d74673d0

  Merged e1f903b: Merge branch 'grn-table-size' of https://github.com/whombx/groonga into whombx-grn-table-size

  Message:
    doc: move grn_table_size() and grn_table_rename() documents from groonga.h to Sphinx text

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

  Modified: doc/source/reference/api/grn_table.txt (+12 -0)
===================================================================
--- doc/source/reference/api/grn_table.txt    2013-08-09 16:27:53 +0900 (88667bc)
+++ doc/source/reference/api/grn_table.txt    2013-08-09 17:08:40 +0900 (fb41f07)
@@ -56,3 +56,15 @@ Reference
    :param table: 対象tableを指定します。
    :param key: 検索keyを指定します。
    :param added: NULL以外の値が指定された場合、新たにrecordが追加された時には1が、既存recordだった時には0がセットされます。
+
+.. c:function:: unsigned int grn_table_size(grn_ctx *ctx, grn_obj *table)
+
+   tableに登録されているレコードの件数を返します。
+
+   :param table: 対象tableを指定します。
+
+.. c:function:: grn_rc grn_table_rename(grn_ctx *ctx, grn_obj *table, const char *name, unsigned int name_size)
+
+   ctxが使用するdbにおいてtableに対応する名前をnameに更新します。tableの全てのcolumnも同時に名前が変更されます。tableは永続オブジェクトでなければいけません。
+
+   :param name_size: nameパラメータのsize(byte)を指定します。

  Modified: include/groonga.h (+0 -17)
===================================================================
--- include/groonga.h    2013-08-09 16:27:53 +0900 (2d4f815)
+++ include/groonga.h    2013-08-09 17:08:40 +0900 (3c4403d)
@@ -965,13 +965,6 @@ GRN_API int grn_table_columns(grn_ctx *ctx, grn_obj *table,
 GRN_API grn_obj *grn_obj_column(grn_ctx *ctx, grn_obj *table,
                                 const char *name, unsigned int name_size);
 
-
-/**
- * grn_table_size:
- * @table: 対象table
- *
- * tableに登録されているレコードの件数を返す。
- **/
 GRN_API unsigned int grn_table_size(grn_ctx *ctx, grn_obj *table);
 
 /*-------------------------------------------------------------
@@ -1185,16 +1178,6 @@ GRN_API grn_rc grn_obj_remove(grn_ctx *ctx, grn_obj *obj);
 GRN_API grn_rc grn_obj_rename(grn_ctx *ctx, grn_obj *obj,
                               const char *name, unsigned int name_size);
 
-/**
- * grn_table_rename:
- * @table: 対象table
- * @name: 新しい名前
- * @name_size: @nameのsize(byte)
- *
- * ctxが使用するdbにおいてtableに対応する名前をnameに更新する。
- * tableの全てのcolumnも同時に名前が変更される。
- * tableは永続オブジェクトでなければならない。
- **/
 GRN_API grn_rc grn_table_rename(grn_ctx *ctx, grn_obj *table,
                                 const char *name, unsigned int name_size);
 
-------------- next part --------------
HTML����������������������������...
Download 



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