[Groonga-commit] groonga/groonga at 0ff3c34 [master] doc: move grn_user_data documents from groonga.h to Sphinx text

Back to archive index

whombx null+****@clear*****
Sat Aug 10 02:15:37 JST 2013


whombx	2013-08-10 02:15:37 +0900 (Sat, 10 Aug 2013)

  New Revision: 0ff3c34cb7902c53ed5253e76cbf430cdbc22dbc
  https://github.com/groonga/groonga/commit/0ff3c34cb7902c53ed5253e76cbf430cdbc22dbc

  Merged 95cd65c: Merge pull request #93 from whombx/grn-user-data

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

  Added files:
    doc/source/reference/api/grn_user_data.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 02:15:37 +0900 (64e4c12)
@@ -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_user_data.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_user_data.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_user_data.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_user_data.html \
 	html/reference/cast.html \
 	html/reference/command.html \
 	html/reference/command/command_version.html \

  Added: doc/source/reference/api/grn_user_data.txt (+29 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/reference/api/grn_user_data.txt    2013-08-10 02:15:37 +0900 (ece5efd)
@@ -0,0 +1,29 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``grn_user_data``
+=================
+
+Summary
+-------
+
+TODO...
+
+Example
+-------
+
+TODO...
+
+Reference
+---------
+
+.. c:type:: grn_user_data
+
+   TODO...
+
+.. c:function:: grn_user_data *grn_obj_user_data(grn_ctx *ctx, grn_obj *obj)
+
+   objectに登録できるユーザデータへのポインタを返します。table, column, proc, exprのみ使用可能です。
+
+   :param obj: 対象objectを指定します。

  Modified: include/groonga.h (+0 -6)
===================================================================
--- include/groonga.h    2013-08-09 23:39:17 +0900 (d99e79d)
+++ include/groonga.h    2013-08-10 02:15:37 +0900 (f6d536b)
@@ -887,12 +887,6 @@ GRN_API grn_rc grn_obj_reinit(grn_ctx *ctx, grn_obj *obj, grn_id domain, unsigne
  **/
 GRN_API void grn_obj_unlink(grn_ctx *ctx, grn_obj *obj);
 
-/**
- * grn_obj_user_data
- * @obj: 対象object
- *
- * objectに登録できるユーザデータへのポインタを返す。table, column, proc, exprのみ使用可能。
- **/
 GRN_API grn_user_data *grn_obj_user_data(grn_ctx *ctx, grn_obj *obj);
 
 /**
-------------- next part --------------
HTML����������������������������...
Download 



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