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

Back to archive index

whombx null+****@clear*****
Sat Aug 10 01:53:31 JST 2013


whombx	2013-08-10 01:53:31 +0900 (Sat, 10 Aug 2013)

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

  Merged 2b19562: Merge pull request #92 from whombx/grn-command-version

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

  Added files:
    doc/source/reference/api/grn_command_version.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 01:53:31 +0900 (5af0271)
@@ -348,6 +348,7 @@ absolute_source_files = \
 	$(top_srcdir)/doc/source/reference.txt \
 	$(top_srcdir)/doc/source/reference/api.txt \
 	$(top_srcdir)/doc/source/reference/api/grn_column.txt \
+	$(top_srcdir)/doc/source/reference/api/grn_command_version.txt \
 	$(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_encoding.txt \
@@ -819,6 +820,7 @@ source_files_relative_from_doc_dir = \
 	source/reference.txt \
 	source/reference/api.txt \
 	source/reference/api/grn_column.txt \
+	source/reference/api/grn_command_version.txt \
 	source/reference/api/grn_ctx.txt \
 	source/reference/api/grn_db.txt \
 	source/reference/api/grn_encoding.txt \
@@ -1057,6 +1059,7 @@ html_files_relative_from_locale_dir = \
 	html/_sources/reference.txt \
 	html/_sources/reference/api.txt \
 	html/_sources/reference/api/grn_column.txt \
+	html/_sources/reference/api/grn_command_version.txt \
 	html/_sources/reference/api/grn_ctx.txt \
 	html/_sources/reference/api/grn_db.txt \
 	html/_sources/reference/api/grn_encoding.txt \
@@ -1228,6 +1231,7 @@ html_files_relative_from_locale_dir = \
 	html/reference.html \
 	html/reference/api.html \
 	html/reference/api/grn_column.html \
+	html/reference/api/grn_command_version.html \
 	html/reference/api/grn_ctx.html \
 	html/reference/api/grn_db.html \
 	html/reference/api/grn_encoding.html \

  Added: doc/source/reference/api/grn_command_version.txt (+37 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/reference/api/grn_command_version.txt    2013-08-10 01:53:31 +0900 (d0b31af)
@@ -0,0 +1,37 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``grn_command_version``
+=======================
+
+Summary
+-------
+
+TODO...
+
+Example
+-------
+
+TODO...
+
+Reference
+---------
+
+.. c:type:: grn_command_version
+
+.. c:macro:: GRN_COMMAND_VERSION_MIN
+
+.. c:macro:: GRN_COMMAND_VERSION_STABLE
+
+.. c:macro:: GRN_COMMAND_VERSION_MAX
+
+.. c:function:: grn_command_version grn_get_default_command_version(void)
+
+   デフォルトのcommand_versionを返します。
+
+.. c:function:: grn_rc grn_set_default_command_version(grn_command_version version)
+
+   デフォルトのcommand_versionを変更します。
+
+   :param version: 変更後のデフォルトのcommand_versionを指定します。

  Modified: include/groonga.h (+0 -13)
===================================================================
--- include/groonga.h    2013-08-09 23:39:17 +0900 (d99e79d)
+++ include/groonga.h    2013-08-10 01:53:31 +0900 (219bb42)
@@ -235,21 +235,8 @@ GRN_API grn_rc grn_set_default_encoding(grn_encoding encoding);
 GRN_API const char *grn_get_version(void);
 GRN_API const char *grn_get_package(void);
 
-/**
- * grn_get_default_command_version:
- *
- * デフォルトのcommand_versionを返します。
- **/
 GRN_API grn_command_version grn_get_default_command_version(void);
-
-/**
- * grn_set_default_command_version:
- * @version: 変更後のデフォルトのcommand_versionを指定します。
- *
- * デフォルトのcommand_versionを変更します。
- **/
 GRN_API grn_rc grn_set_default_command_version(grn_command_version version);
-
 GRN_API grn_command_version grn_ctx_get_command_version(grn_ctx *ctx);
 GRN_API grn_rc grn_ctx_set_command_version(grn_ctx *ctx, grn_command_version version);
 GRN_API long long int grn_ctx_get_match_escalation_threshold(grn_ctx *ctx);
-------------- next part --------------
HTML����������������������������...
Download 



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