From: Yusuke Endoh <mame@...>
Date: 2011-05-24T22:06:59+09:00
Subject: [ruby-core:36426] [Ruby 1.9 - Bug #4748][Open] documentation updates: Curses and friends are 100% documented


Issue #4748 has been updated by Yusuke Endoh.

Status changed from Closed to Open

Hello,

+ * === Constants
+ *
+ * For whatever reason, these are not picked up in the RDoc
+ * These are Integer of the colors.
+ *
+ * * COLOR_BLACK       = 0
+ * * COLOR_RED         = 1
+ * * COLOR_GREEN       = 2
+ * * COLOR_YELLOW      = 3
+ * * COLOR_BLUE                = 4
+ * * COLOR_MAGENTA     = 5
+ * * COLOR_CYAN                = 6
+ * * COLOR_WHITE       = 7
+ *
+ *

These actual values must not be documented.

These constants just export ones of curses.h.
Some environments have a different integer set.  For example,
I heard that COLOR_RED is 4 in windows.
In addition, Ruby curses library can change the actual value in
future.  For example, it might be better for such a constant to
have a Symbol.


+    /*
+     * Document-const: Curses::COLOR_BLACK
+     *
+     * Integer of the color black
+     */

For the same reason, "Integer" should not be mentioned.

-- 
Yusuke Endoh <mame@tsg.ne.jp>
----------------------------------------
Bug #4748: documentation updates: Curses and friends are 100% documented
http://redmine.ruby-lang.org/issues/4748

Author: Vincent Batts
Status: Open
Priority: Normal
Assignee: Eric Hodel
Category: DOC
Target version: 1.9.3
ruby -v: ruby 1.9.3dev (2011-05-20 trunk 31647) [x86_64-linux]


well 100% per the rdoc report.
Sadly there are a host of constants that are not being picked up by RDoc (I intend to follow up on that)




-- 
http://redmine.ruby-lang.org