[Groonga-commit] groonga/groonga at b65bb6e [master] doc: move grn_ii documents from groonga.h to Sphinx text

Back to archive index

whombx null+****@clear*****
Sat Aug 10 08:24:22 JST 2013


whombx	2013-08-10 08:24:22 +0900 (Sat, 10 Aug 2013)

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

  Merged c7d5bdf: Merge branch 'grn-ii' of https://github.com/whombx/groonga into whombx-grn-ii

  Message:
    doc: move grn_ii documents from groonga.h to Sphinx text

  Added files:
    doc/source/reference/api/grn_ii.txt
  Modified files:
    doc/files.am
    include/groonga.h

  Modified: doc/files.am (+4 -0)
===================================================================
--- doc/files.am    2013-08-09 23:39:17 +0900 (b1a688b)
+++ doc/files.am    2013-08-10 08:24:22 +0900 (16e9514)
@@ -352,6 +352,7 @@ absolute_source_files = \
 	$(top_srcdir)/doc/source/reference/api/grn_db.txt \
 	$(top_srcdir)/doc/source/reference/api/grn_encoding.txt \
 	$(top_srcdir)/doc/source/reference/api/grn_expr.txt \
+	$(top_srcdir)/doc/source/reference/api/grn_ii.txt \
 	$(top_srcdir)/doc/source/reference/api/grn_index_cursor.txt \
 	$(top_srcdir)/doc/source/reference/api/grn_info.txt \
 	$(top_srcdir)/doc/source/reference/api/grn_obj.txt \
@@ -823,6 +824,7 @@ source_files_relative_from_doc_dir = \
 	source/reference/api/grn_db.txt \
 	source/reference/api/grn_encoding.txt \
 	source/reference/api/grn_expr.txt \
+	source/reference/api/grn_ii.txt \
 	source/reference/api/grn_index_cursor.txt \
 	source/reference/api/grn_info.txt \
 	source/reference/api/grn_obj.txt \
@@ -1061,6 +1063,7 @@ html_files_relative_from_locale_dir = \
 	html/_sources/reference/api/grn_db.txt \
 	html/_sources/reference/api/grn_encoding.txt \
 	html/_sources/reference/api/grn_expr.txt \
+	html/_sources/reference/api/grn_ii.txt \
 	html/_sources/reference/api/grn_index_cursor.txt \
 	html/_sources/reference/api/grn_info.txt \
 	html/_sources/reference/api/grn_obj.txt \
@@ -1232,6 +1235,7 @@ html_files_relative_from_locale_dir = \
 	html/reference/api/grn_db.html \
 	html/reference/api/grn_encoding.html \
 	html/reference/api/grn_expr.html \
+	html/reference/api/grn_ii.html \
 	html/reference/api/grn_index_cursor.html \
 	html/reference/api/grn_info.html \
 	html/reference/api/grn_obj.html \

  Added: doc/source/reference/api/grn_ii.txt (+35 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/reference/api/grn_ii.txt    2013-08-10 08:24:22 +0900 (9b6e626)
@@ -0,0 +1,35 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``grn_ii``
+==========
+
+Summary
+-------
+
+buffered index builder
+
+特定のアプリケーション用に準備した内部APIです。
+
+TODO...
+
+Example
+-------
+
+TODO...
+
+Reference
+---------
+
+.. c:type:: grn_ii
+
+.. c:type:: grn_ii_buffer
+
+.. c:function:: grn_ii_buffer *grn_ii_buffer_open(grn_ctx *ctx, grn_ii *ii, long long unsigned int update_buffer_size)
+
+.. c:function:: grn_rc grn_ii_buffer_append(grn_ctx *ctx, grn_ii_buffer *ii_buffer, grn_id rid, unsigned int section, grn_obj *value)
+
+.. c:function:: grn_rc grn_ii_buffer_commit(grn_ctx *ctx, grn_ii_buffer *ii_buffer)
+
+.. c:function:: grn_rc grn_ii_buffer_close(grn_ctx *ctx, grn_ii_buffer *ii_buffer)

  Modified: include/groonga.h (+0 -1)
===================================================================
--- include/groonga.h    2013-08-09 23:39:17 +0900 (d99e79d)
+++ include/groonga.h    2013-08-10 08:24:22 +0900 (182742f)
@@ -2345,7 +2345,6 @@ GRN_API grn_rc grn_dat_cursor_delete(grn_ctx *ctx, grn_dat_cursor *c,
 } while (0)
 
 /* buffered index builder */
-/* 特定のアプリケーション用に準備した内部APIです。 */
 
 typedef struct _grn_ii grn_ii;
 typedef struct _grn_ii_buffer grn_ii_buffer;
-------------- next part --------------
HTML����������������������������...
다운로드 



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