Bug #4880: documentation updates: Curses is 100% (for real this time)

• Status: Closed
• Assignee: drbrain (Eric Hodel)
• Target version: 1.9.3
• ruby -v: ruby 1.9.3dev (2011-06-14 trunk 32073) [x86_64-linux]

[vbatts (Vincent Batts)]

Thanks to drbrain for picking up the rdoc bug to document the constants defined using rb_curses_define_const()

Now the following have been documented.

module Curses

in file curses.c

A_ATTRIBUTES = nil

in file curses.c

A_NORMAL = nil

in file curses.c

A_STANDOUT = nil

in file curses.c

A_UNDERLINE = nil

in file curses.c

A_REVERSE = nil

in file curses.c

A_BLINK = nil

in file curses.c

A_DIM = nil

in file curses.c

A_BOLD = nil

in file curses.c

A_PROTECT = nil

in file curses.c

A_INVIS = nil

in file curses.c

A_ALTCHARSET = nil

in file curses.c

A_CHARTEXT = nil

in file curses.c

A_HORIZONTAL = nil

in file curses.c

A_LEFT = nil

in file curses.c

A_LOW = nil

in file curses.c

A_RIGHT = nil

in file curses.c

A_TOP = nil

in file curses.c

A_VERTICAL = nil

in file curses.c

A_COLOR = nil

in file curses.c

BUTTON1_PRESSED = nil

in file curses.c

BUTTON1_RELEASED = nil

in file curses.c

BUTTON1_CLICKED = nil

in file curses.c

BUTTON1_DOUBLE_CLICKED = nil

in file curses.c

BUTTON1_TRIPLE_CLICKED = nil

in file curses.c

BUTTON2_PRESSED = nil

in file curses.c

BUTTON2_RELEASED = nil

in file curses.c

BUTTON2_CLICKED = nil

in file curses.c

BUTTON2_DOUBLE_CLICKED = nil

in file curses.c

BUTTON2_TRIPLE_CLICKED = nil

in file curses.c

BUTTON3_PRESSED = nil

in file curses.c

BUTTON3_RELEASED = nil

in file curses.c

BUTTON3_CLICKED = nil

in file curses.c

BUTTON3_DOUBLE_CLICKED = nil

in file curses.c

BUTTON3_TRIPLE_CLICKED = nil

in file curses.c

BUTTON4_PRESSED = nil

in file curses.c

BUTTON4_RELEASED = nil

in file curses.c

BUTTON4_CLICKED = nil

in file curses.c

BUTTON4_DOUBLE_CLICKED = nil

in file curses.c

BUTTON4_TRIPLE_CLICKED = nil

in file curses.c

BUTTON_SHIFT = nil

in file curses.c

BUTTON_CTRL = nil

in file curses.c

BUTTON_ALT = nil

in file curses.c

ALL_MOUSE_EVENTS = nil

in file curses.c

REPORT_MOUSE_POSITION = nil

in file curses.c

KEY_MOUSE = nil

in file curses.c

KEY_MIN = nil

in file curses.c

KEY_BREAK = nil

in file curses.c

KEY_DOWN = nil

in file curses.c

KEY_UP = nil

in file curses.c

KEY_LEFT = nil

in file curses.c

KEY_RIGHT = nil

in file curses.c

KEY_HOME = nil

in file curses.c

KEY_BACKSPACE = nil

in file curses.c

KEY_DL = nil

in file curses.c

KEY_IL = nil

in file curses.c

KEY_DC = nil

in file curses.c

KEY_IC = nil

in file curses.c

KEY_EIC = nil

in file curses.c

KEY_CLEAR = nil

in file curses.c

KEY_EOS = nil

in file curses.c

KEY_EOL = nil

in file curses.c

KEY_SF = nil

in file curses.c

KEY_SR = nil

in file curses.c

KEY_NPAGE = nil

in file curses.c

KEY_PPAGE = nil

in file curses.c

KEY_STAB = nil

in file curses.c

KEY_CTAB = nil

in file curses.c

KEY_CATAB = nil

in file curses.c

KEY_ENTER = nil

in file curses.c

KEY_SRESET = nil

in file curses.c

KEY_RESET = nil

in file curses.c

KEY_PRINT = nil

in file curses.c

KEY_LL = nil

in file curses.c

KEY_A1 = nil

in file curses.c

KEY_A3 = nil

in file curses.c

KEY_B2 = nil

in file curses.c

KEY_C1 = nil

in file curses.c

KEY_C3 = nil

in file curses.c

KEY_BTAB = nil

in file curses.c

KEY_BEG = nil

in file curses.c

KEY_CANCEL = nil

in file curses.c

KEY_CLOSE = nil

in file curses.c

KEY_COMMAND = nil

in file curses.c

KEY_COPY = nil

in file curses.c

KEY_CREATE = nil

in file curses.c

KEY_END = nil

in file curses.c

KEY_EXIT = nil

in file curses.c

KEY_FIND = nil

in file curses.c

KEY_HELP = nil

in file curses.c

KEY_MARK = nil

in file curses.c

KEY_MESSAGE = nil

in file curses.c

KEY_MOVE = nil

in file curses.c

KEY_NEXT = nil

in file curses.c

KEY_OPEN = nil

in file curses.c

KEY_OPTIONS = nil

in file curses.c

KEY_PREVIOUS = nil

in file curses.c

KEY_REDO = nil

in file curses.c

KEY_REFERENCE = nil

in file curses.c

KEY_REFRESH = nil

in file curses.c

KEY_REPLACE = nil

in file curses.c

KEY_RESTART = nil

in file curses.c

KEY_RESUME = nil

in file curses.c

KEY_SAVE = nil

in file curses.c

KEY_SBEG = nil

in file curses.c

KEY_SCANCEL = nil

in file curses.c

KEY_SCOMMAND = nil

in file curses.c

KEY_SCOPY = nil

in file curses.c

KEY_SCREATE = nil

in file curses.c

KEY_SDC = nil

in file curses.c

KEY_SDL = nil

in file curses.c

KEY_SELECT = nil

in file curses.c

KEY_SEND = nil

in file curses.c

KEY_SEOL = nil

in file curses.c

KEY_SEXIT = nil

in file curses.c

KEY_SFIND = nil

in file curses.c

KEY_SHELP = nil

in file curses.c

KEY_SHOME = nil

in file curses.c

KEY_SIC = nil

in file curses.c

KEY_SLEFT = nil

in file curses.c

KEY_SMESSAGE = nil

in file curses.c

KEY_SMOVE = nil

in file curses.c

KEY_SNEXT = nil

in file curses.c

KEY_SOPTIONS = nil

in file curses.c

KEY_SPREVIOUS = nil

in file curses.c

KEY_SPRINT = nil

in file curses.c

KEY_SREDO = nil

in file curses.c

KEY_SREPLACE = nil

in file curses.c

KEY_SRIGHT = nil

in file curses.c

KEY_SRSUME = nil

in file curses.c

KEY_SSAVE = nil

in file curses.c

KEY_SSUSPEND = nil

in file curses.c

KEY_SUNDO = nil

in file curses.c

KEY_SUSPEND = nil

in file curses.c

KEY_UNDO = nil

in file curses.c

KEY_RESIZE = nil

in file curses.c

KEY_MAX = nil
end

[vbatts (Vincent Batts)]

• File ruby_doc_updates-20110613_update-curses_vbatts.patch ruby_doc_updates-20110613_update-curses_vbatts.patch added

Err. adding an updated patch, that removes the TODO regarding the constants

[drbrain (Eric Hodel)]

• File deleted (ruby_doc_updates-20110613-curses_vbatts.patch)

[drbrain (Eric Hodel)]

• Status changed from Open to Closed
• % Done changed from 0 to 100

This issue was solved with changeset r32144.
Vincent, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.

---

• ext/curses/curses.c: Document curses constants. Patch by Vincent
  Batts. [Ruby 1.9 - Bug #4880]