[Groonga-commit] ranguba/rroonga at 28c3fec [master] doc: use macro for common options

Back to archive index

Masafumi Yokoyama null+****@clear*****
Fri Feb 13 21:11:05 JST 2015


Masafumi Yokoyama	2015-02-13 21:11:05 +0900 (Fri, 13 Feb 2015)

  New Revision: 28c3fecff1175d5ba6b9e9eb2bba1bd87386ab41
  https://github.com/ranguba/rroonga/commit/28c3fecff1175d5ba6b9e9eb2bba1bd87386ab41

  Message:
    doc: use macro for common options

  Modified files:
    ext/groonga/rb-grn-table.c

  Modified: ext/groonga/rb-grn-table.c (+10 -3)
===================================================================
--- ext/groonga/rb-grn-table.c    2015-02-13 19:48:42 +0900 (ac11edb)
+++ ext/groonga/rb-grn-table.c    2015-02-13 21:11:05 +0900 (7758881)
@@ -1333,11 +1333,18 @@ rb_grn_table_sort (int argc, VALUE *argv, VALUE self)
  *
  * @overload group([key1, key2, ...], options={})
  *   @return [Groonga::Hash]
+ *
+ *   @!macro [new] table.group.options
+ *     @option options :max_n_sub_records
+ *       グループ化した後のレコードのそれぞれについて最大 _:max_n_sub_records_ 件まで
+ *       そのグループに含まれる _table_ のレコードをサブレコードとして格納する。
+ *
+ *   @!macro table.group.options
+ *
  * @overload group(key, options={})
  *   @return [Groonga::Hash]
- * @option options :max_n_sub_records
- *   グループ化した後のレコードのそれぞれについて最大 _:max_n_sub_records_ 件まで
- *   そのグループに含まれる _table_ のレコードをサブレコードとして格納する。
+ *
+ *   @!macro table.group.options
  */
 static VALUE
 rb_grn_table_group (int argc, VALUE *argv, VALUE self)
-------------- next part --------------
HTML����������������������������...
Download 



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