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

Zurück zum Archiv-Index

whombx null+****@clear*****
Sat Aug 10 07:22:13 JST 2013


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

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

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

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

  Added files:
    doc/source/reference/api/grn_type.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 07:22:13 +0900 (0edde4f)
@@ -358,6 +358,7 @@ absolute_source_files = \
 	$(top_srcdir)/doc/source/reference/api/grn_proc.txt \
 	$(top_srcdir)/doc/source/reference/api/grn_table.txt \
 	$(top_srcdir)/doc/source/reference/api/grn_table_cursor.txt \
+	$(top_srcdir)/doc/source/reference/api/grn_type.txt \
 	$(top_srcdir)/doc/source/reference/cast.txt \
 	$(top_srcdir)/doc/source/reference/command.txt \
 	$(top_srcdir)/doc/source/reference/command/command_version.txt \
@@ -828,6 +829,7 @@ source_files_relative_from_doc_dir = \
 	source/reference/api/grn_obj.txt \
 	source/reference/api/grn_table.txt \
 	source/reference/api/grn_table_cursor.txt \
+	source/reference/api/grn_type.txt \
 	source/reference/api/grn_proc.txt \
 	source/reference/cast.txt \
 	source/reference/command.txt \
@@ -1067,6 +1069,7 @@ html_files_relative_from_locale_dir = \
 	html/_sources/reference/api/grn_proc.txt \
 	html/_sources/reference/api/grn_table.txt \
 	html/_sources/reference/api/grn_table_cursor.txt \
+	html/_sources/reference/api/grn_type.txt \
 	html/_sources/reference/cast.txt \
 	html/_sources/reference/command.txt \
 	html/_sources/reference/command/command_version.txt \
@@ -1238,6 +1241,7 @@ html_files_relative_from_locale_dir = \
 	html/reference/api/grn_proc.html \
 	html/reference/api/grn_table.html \
 	html/reference/api/grn_table_cursor.html \
+	html/reference/api/grn_type.html \
 	html/reference/cast.html \
 	html/reference/command.html \
 	html/reference/command/command_version.html \

  Added: doc/source/reference/api/grn_type.txt (+31 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/reference/api/grn_type.txt    2013-08-10 07:22:13 +0900 (bf53385)
@@ -0,0 +1,31 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``grn_type``
+============
+
+Summary
+-------
+
+TODO...
+
+Example
+-------
+
+TODO...
+
+Reference
+---------
+
+.. c:type:: grn_builtin_type
+
+   TODO...
+
+.. c:function:: grn_obj *grn_type_create(grn_ctx *ctx, const char *name, unsigned int name_size, grn_obj_flags flags, unsigned int size)
+
+   nameに対応する新たなtype(型)をdbに定義します。
+
+   :param name: 作成するtypeの名前を指定します。
+   :param flags: ``GRN_OBJ_KEY_VAR_SIZE``, ``GRN_OBJ_KEY_FLOAT``, ``GRN_OBJ_KEY_INT``, ``GRN_OBJ_KEY_UINT`` のいずれかを指定します。
+   :param size: ``GRN_OBJ_KEY_VAR_SIZE`` の場合は最大長、それ以外の場合は長さ(単位:byte)を指定します。

  Modified: include/groonga.h (+0 -11)
===================================================================
--- include/groonga.h    2013-08-09 23:39:17 +0900 (d99e79d)
+++ include/groonga.h    2013-08-10 07:22:13 +0900 (74423ce)
@@ -463,17 +463,6 @@ typedef enum {
 
 GRN_API grn_obj *grn_ctx_at(grn_ctx *ctx, grn_id id);
 
-/**
- * grn_type_create:
- * @name: 作成するtypeの名前。
- * @flags: GRN_OBJ_KEY_VAR_SIZE, GRN_OBJ_KEY_FLOAT, GRN_OBJ_KEY_INT, GRN_OBJ_KEY_UINT
- *        のいずれかを指定
- * @size: GRN_OBJ_KEY_VAR_SIZEの場合は最大長、
- *        それ以外の場合は長さを指定(単位:byte)
- *
- * nameに対応する新たなtype(型)をdbに定義する。
- **/
-
 GRN_API grn_obj *grn_type_create(grn_ctx *ctx, const char *name, unsigned int name_size,
                                  grn_obj_flags flags, unsigned int size);
 
-------------- next part --------------
HTML����������������������������...
Download 



More information about the Groonga-commit mailing list
Zurück zum Archiv-Index