Bug #4880

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

Added by Vincent Batts almost 3 years ago. Updated almost 3 years ago.

[ruby-core:37108]
Status:Closed
Priority:Normal
Assignee:Eric Hodel
Category:doc
Target version:1.9.3
ruby -v:ruby 1.9.3dev (2011-06-14 trunk 32073) [x86_64-linux] Backport:

Description

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

Now the following have been documented.

module Curses

# in file curses.c
AATTRIBUTES = nil
# in file curses.c
A
NORMAL = nil
# in file curses.c
ASTANDOUT = nil
# in file curses.c
A
UNDERLINE = nil
# in file curses.c
AREVERSE = nil
# in file curses.c
A
BLINK = nil
# in file curses.c
ADIM = nil
# in file curses.c
A
BOLD = nil
# in file curses.c
APROTECT = nil
# in file curses.c
A
INVIS = nil
# in file curses.c
AALTCHARSET = nil
# in file curses.c
A
CHARTEXT = nil
# in file curses.c
AHORIZONTAL = nil
# in file curses.c
A
LEFT = nil
# in file curses.c
ALOW = nil
# in file curses.c
A
RIGHT = nil
# in file curses.c
ATOP = nil
# in file curses.c
A
VERTICAL = nil
# in file curses.c
ACOLOR = nil
# in file curses.c
BUTTON1
PRESSED = nil
# in file curses.c
BUTTON1RELEASED = nil
# in file curses.c
BUTTON1
CLICKED = nil
# in file curses.c
BUTTON1DOUBLECLICKED = nil
# in file curses.c
BUTTON1TRIPLECLICKED = nil
# in file curses.c
BUTTON2PRESSED = nil
# in file curses.c
BUTTON2
RELEASED = nil
# in file curses.c
BUTTON2CLICKED = nil
# in file curses.c
BUTTON2
DOUBLECLICKED = nil
# in file curses.c
BUTTON2
TRIPLECLICKED = nil
# in file curses.c
BUTTON3
PRESSED = nil
# in file curses.c
BUTTON3RELEASED = nil
# in file curses.c
BUTTON3
CLICKED = nil
# in file curses.c
BUTTON3DOUBLECLICKED = nil
# in file curses.c
BUTTON3TRIPLECLICKED = nil
# in file curses.c
BUTTON4PRESSED = nil
# in file curses.c
BUTTON4
RELEASED = nil
# in file curses.c
BUTTON4CLICKED = nil
# in file curses.c
BUTTON4
DOUBLECLICKED = nil
# in file curses.c
BUTTON4
TRIPLECLICKED = nil
# in file curses.c
BUTTON
SHIFT = nil
# in file curses.c
BUTTONCTRL = nil
# in file curses.c
BUTTON
ALT = nil
# in file curses.c
ALLMOUSEEVENTS = nil
# in file curses.c
REPORTMOUSEPOSITION = nil
# in file curses.c
KEYMOUSE = nil
# in file curses.c
KEY
MIN = nil
# in file curses.c
KEYBREAK = nil
# in file curses.c
KEY
DOWN = nil
# in file curses.c
KEYUP = nil
# in file curses.c
KEY
LEFT = nil
# in file curses.c
KEYRIGHT = nil
# in file curses.c
KEY
HOME = nil
# in file curses.c
KEYBACKSPACE = nil
# in file curses.c
KEY
DL = nil
# in file curses.c
KEYIL = nil
# in file curses.c
KEY
DC = nil
# in file curses.c
KEYIC = nil
# in file curses.c
KEY
EIC = nil
# in file curses.c
KEYCLEAR = nil
# in file curses.c
KEY
EOS = nil
# in file curses.c
KEYEOL = nil
# in file curses.c
KEY
SF = nil
# in file curses.c
KEYSR = nil
# in file curses.c
KEY
NPAGE = nil
# in file curses.c
KEYPPAGE = nil
# in file curses.c
KEY
STAB = nil
# in file curses.c
KEYCTAB = nil
# in file curses.c
KEY
CATAB = nil
# in file curses.c
KEYENTER = nil
# in file curses.c
KEY
SRESET = nil
# in file curses.c
KEYRESET = nil
# in file curses.c
KEY
PRINT = nil
# in file curses.c
KEYLL = nil
# in file curses.c
KEY
A1 = nil
# in file curses.c
KEYA3 = nil
# in file curses.c
KEY
B2 = nil
# in file curses.c
KEYC1 = nil
# in file curses.c
KEY
C3 = nil
# in file curses.c
KEYBTAB = nil
# in file curses.c
KEY
BEG = nil
# in file curses.c
KEYCANCEL = nil
# in file curses.c
KEY
CLOSE = nil
# in file curses.c
KEYCOMMAND = nil
# in file curses.c
KEY
COPY = nil
# in file curses.c
KEYCREATE = nil
# in file curses.c
KEY
END = nil
# in file curses.c
KEYEXIT = nil
# in file curses.c
KEY
FIND = nil
# in file curses.c
KEYHELP = nil
# in file curses.c
KEY
MARK = nil
# in file curses.c
KEYMESSAGE = nil
# in file curses.c
KEY
MOVE = nil
# in file curses.c
KEYNEXT = nil
# in file curses.c
KEY
OPEN = nil
# in file curses.c
KEYOPTIONS = nil
# in file curses.c
KEY
PREVIOUS = nil
# in file curses.c
KEYREDO = nil
# in file curses.c
KEY
REFERENCE = nil
# in file curses.c
KEYREFRESH = nil
# in file curses.c
KEY
REPLACE = nil
# in file curses.c
KEYRESTART = nil
# in file curses.c
KEY
RESUME = nil
# in file curses.c
KEYSAVE = nil
# in file curses.c
KEY
SBEG = nil
# in file curses.c
KEYSCANCEL = nil
# in file curses.c
KEY
SCOMMAND = nil
# in file curses.c
KEYSCOPY = nil
# in file curses.c
KEY
SCREATE = nil
# in file curses.c
KEYSDC = nil
# in file curses.c
KEY
SDL = nil
# in file curses.c
KEYSELECT = nil
# in file curses.c
KEY
SEND = nil
# in file curses.c
KEYSEOL = nil
# in file curses.c
KEY
SEXIT = nil
# in file curses.c
KEYSFIND = nil
# in file curses.c
KEY
SHELP = nil
# in file curses.c
KEYSHOME = nil
# in file curses.c
KEY
SIC = nil
# in file curses.c
KEYSLEFT = nil
# in file curses.c
KEY
SMESSAGE = nil
# in file curses.c
KEYSMOVE = nil
# in file curses.c
KEY
SNEXT = nil
# in file curses.c
KEYSOPTIONS = nil
# in file curses.c
KEY
SPREVIOUS = nil
# in file curses.c
KEYSPRINT = nil
# in file curses.c
KEY
SREDO = nil
# in file curses.c
KEYSREPLACE = nil
# in file curses.c
KEY
SRIGHT = nil
# in file curses.c
KEYSRSUME = nil
# in file curses.c
KEY
SSAVE = nil
# in file curses.c
KEYSSUSPEND = nil
# in file curses.c
KEY
SUNDO = nil
# in file curses.c
KEYSUSPEND = nil
# in file curses.c
KEY
UNDO = nil
# in file curses.c
KEYRESIZE = nil
# in file curses.c
KEY
MAX = nil
end

ruby_doc_updates-20110613_update-curses_vbatts.patch Magnifier (34 KB) Vincent Batts, 06/14/2011 05:42 AM

Associated revisions

Revision 32144
Added by Eric Hodel almost 3 years ago

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

History

#1 Updated by Vincent Batts almost 3 years ago

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

#2 Updated by Eric Hodel almost 3 years ago

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

#3 Updated by Eric Hodel almost 3 years ago

  • 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]

Also available in: Atom PDF