[Groonga-commit] groonga/groonga at f08d969 [master] doc: move grn_obj_column() document from groonga.h to Sphinx text

Back to archive index

whombx null+****@clear*****
Thu Aug 8 00:06:20 JST 2013


whombx	2013-08-08 00:06:20 +0900 (Thu, 08 Aug 2013)

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

  Merged eada414: Merge branch 'grn-obj-column' of https://github.com/whombx/groonga into whombx-grn-obj-column

  Message:
    doc: move grn_obj_column() document from groonga.h to Sphinx text

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

  Modified: doc/files.am (+4 -0)
===================================================================
--- doc/files.am    2013-08-07 13:46:53 +0900 (593766e)
+++ doc/files.am    2013-08-08 00:06:20 +0900 (66b41b8)
@@ -350,6 +350,7 @@ absolute_source_files = \
 	$(top_srcdir)/doc/source/reference/api/grn_ctx.txt \
 	$(top_srcdir)/doc/source/reference/api/grn_db.txt \
 	$(top_srcdir)/doc/source/reference/api/grn_expr.txt \
+	$(top_srcdir)/doc/source/reference/api/grn_obj.txt \
 	$(top_srcdir)/doc/source/reference/api/grn_table_cursor.txt \
 	$(top_srcdir)/doc/source/reference/cast.txt \
 	$(top_srcdir)/doc/source/reference/command.txt \
@@ -814,6 +815,7 @@ source_files_relative_from_doc_dir = \
 	source/reference/api/grn_ctx.txt \
 	source/reference/api/grn_db.txt \
 	source/reference/api/grn_expr.txt \
+	source/reference/api/grn_obj.txt \
 	source/reference/api/grn_table_cursor.txt \
 	source/reference/cast.txt \
 	source/reference/command.txt \
@@ -1045,6 +1047,7 @@ html_files_relative_from_locale_dir = \
 	html/_sources/reference/api/grn_ctx.txt \
 	html/_sources/reference/api/grn_db.txt \
 	html/_sources/reference/api/grn_expr.txt \
+	html/_sources/reference/api/grn_obj.txt \
 	html/_sources/reference/api/grn_table_cursor.txt \
 	html/_sources/reference/cast.txt \
 	html/_sources/reference/command.txt \
@@ -1209,6 +1212,7 @@ html_files_relative_from_locale_dir = \
 	html/reference/api/grn_ctx.html \
 	html/reference/api/grn_db.html \
 	html/reference/api/grn_expr.html \
+	html/reference/api/grn_obj.html \
 	html/reference/api/grn_table_cursor.html \
 	html/reference/cast.html \
 	html/reference/command.html \

  Added: doc/source/reference/api/grn_obj.txt (+33 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/reference/api/grn_obj.txt    2013-08-08 00:06:20 +0900 (f0d4f5d)
@@ -0,0 +1,33 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``grn_obj``
+===========
+
+Summary
+-------
+
+TODO...
+
+Example
+-------
+
+TODO...
+
+Reference
+---------
+
+.. c:type:: grn_obj
+
+   TODO...
+
+.. c:function:: grn_obj *grn_obj_column(grn_ctx *ctx, grn_obj *table, const char *name, unsigned int name_size)
+
+   nameがカラム名の場合、それに対応するtableのカラムを返します。対応するカラムが存在しなければNULLを返します。
+
+   nameはアクセサ文字列の場合、それに対応するaccessorを返します。アクセサ文字列とは、カラム名等を'.'で連結した文字列です。'_id', '_key'は特殊なアクセサで、それぞれレコードID/keyを返します。例) 'col1' / 'col2.col3' / 'col2._id'
+
+   :param table: 対象tableを指定します。
+   :param name: カラム名を指定します。
+

  Modified: include/groonga.h (+0 -13)
===================================================================
--- include/groonga.h    2013-08-07 13:46:53 +0900 (9438149)
+++ include/groonga.h    2013-08-08 00:06:20 +0900 (f6d492f)
@@ -1059,22 +1059,9 @@ GRN_API int grn_table_columns(grn_ctx *ctx, grn_obj *table,
                               const char *name, unsigned int name_size,
                               grn_obj *res);
 
-/**
- * grn_obj_column:
- * @table: 対象table
- * @name: カラム名
- *
- * nameがカラム名の場合、それに対応するtableのカラムを返す。
- * 対応するカラムが存在しなければNULLを返す。
- * nameはアクセサ文字列の場合、それに対応するaccessorを返す。
- * アクセサ文字列とは、カラム名等を'.'で連結した文字列である。
- * '_id', '_key'は特殊なアクセサで、それぞれレコードID/keyを返す。
- * 例) 'col1' / 'col2.col3' / 'col2._id'
- **/
 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
-------------- next part --------------
HTML����������������������������...
Download 



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