[Groonga-commit] groonga/groonga at 5529f06 [master] doc: fix wrong c:member usage

Back to archive index

Kouhei Sutou null+****@clear*****
Sun Aug 4 23:01:30 JST 2013


Kouhei Sutou	2013-08-04 23:01:30 +0900 (Sun, 04 Aug 2013)

  New Revision: 5529f060fab99656bc8fc04f2964534107feeb5a
  https://github.com/groonga/groonga/commit/5529f060fab99656bc8fc04f2964534107feeb5a

  Message:
    doc: fix wrong c:member usage
    
    It should include type and struct name.
    
    http://sphinx-doc.org/domains.html#directive-c:member
    
        .. c:member:: PyObject* PyTypeObject.tp_bases

  Modified files:
    doc/source/reference/api/grn_db.txt

  Modified: doc/source/reference/api/grn_db.txt (+4 -4)
===================================================================
--- doc/source/reference/api/grn_db.txt    2013-08-04 22:53:07 +0900 (6b75077)
+++ doc/source/reference/api/grn_db.txt    2013-08-04 23:01:30 +0900 (033fd5e)
@@ -26,13 +26,13 @@ TODO...
 
 .. c:type:: grn_db_create_optarg
 
-.. c:member:: builtin_type_names
+.. c:member:: char **grn_db_create_optarg.builtin_type_names
 
-   :c:type:`grn_db_create_optarg` のメンバ。組み込み型の名前となるnul終端文字列の配列を指定する。
+   組み込み型の名前となるnul終端文字列の配列を指定する。
 
-.. c:member:: n_builtin_type_names
+.. c:member:: int grn_db_create_optarg..n_builtin_type_names
 
-   :c:type:`grn_db_create_optarg` のメンバ。n_builtin_type_namesには、optarg.builtin_type_namesで指定する文字列の数を
+   n_builtin_type_namesには、optarg.builtin_type_namesで指定する文字列の数を
    指定する。配列のoffsetはenum型grn_builtin_typeの値に対応する。
 
 .. c:function:: grn_obj *grn_db_create(grn_ctx *ctx, const char *path, grn_db_create_optarg *optarg)
-------------- next part --------------
HTML����������������������������...
Download 



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