[Groonga-commit] ranguba/rroonga at 561c633 [master] doc: use YARD markup

Back to archive index

Kouhei Sutou null+****@clear*****
Mon Apr 13 16:39:01 JST 2015


Kouhei Sutou	2015-04-13 16:39:01 +0900 (Mon, 13 Apr 2015)

  New Revision: 561c633230dd516d401553b3ae7bbdd3d311b1b5
  https://github.com/ranguba/rroonga/commit/561c633230dd516d401553b3ae7bbdd3d311b1b5

  Message:
    doc: use YARD markup

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

  Modified: ext/groonga/rb-grn-column.c (+9 -12)
===================================================================
--- ext/groonga/rb-grn-column.c    2015-04-13 16:35:17 +0900 (352029d)
+++ ext/groonga/rb-grn-column.c    2015-04-13 16:39:01 +0900 (6f4efa1)
@@ -195,13 +195,13 @@ rb_grn_column_get_local_name (VALUE self)
  * {Groonga::Expression#snippet} を使うことにより、指定した条件
  * 用のスニペットを簡単に生成できる。
  *
- * bc. !!!ruby
+ * @example Shows texts around "Groonga"
  *   results = description_column.select do |column|
- *     column =~ "groonga"
+ *     column =~ "Groonga"
  *   end
  *   snippet = results.expression.snippet([["<em>", "</em>"]])
  *   results.each do |record|
- *     puts "#{record['name']}の説明文の中で「groonga」が含まれる部分"
+ *     puts "#{record['name']}の説明文の中で「Groonga」を含む部分"
  *     snippet.execute(record["description"]).each do |snippet|
  *       puts "---"
  *       puts "#{snippet}..."
@@ -209,15 +209,12 @@ rb_grn_column_get_local_name (VALUE self)
  *     end
  *   end
  *
- * 出力例
- *
- * <pre>
- * !!!text
- * rroongaの説明文の中で「groonga」が含まれる部分
- * ---
- * rroongaは<em>groonga</em>のいわゆるDB-APIの層の...
- * ---
- * </pre>
+ *   # Sample output:
+ *   #
+ *   # Rroongaの説明文の中で「Groonga」を含む部分
+ *   # ---
+ *   # Rroongaは<em>Groonga</em>のいわゆるDB-APIの層の...
+ *   # ---
  *
  * @return [Groonga::Hash] 検索結果
  * @overload select(options)
-------------- next part --------------
HTML����������������������������...
다운로드 



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