From 625b4298f67c1da6868701972cad884508cbb8e8 Mon Sep 17 00:00:00 2001
From: Lars Kanis <kanis@comcard.de>
Date: Wed, 7 Mar 2012 21:17:53 +0100
Subject: [PATCH] Adjust more rdoc links, so that they work with yard
Remove some comments, to only from C++ usable methods
---
rdoc-sources/FX4Splitter.rb | 4 +--
rdoc-sources/FXAccelTable.rb | 2 +-
rdoc-sources/FXApp.rb | 30 ++++++++++-----------
rdoc-sources/FXBitmap.rb | 10 +++----
rdoc-sources/FXDC.rb | 48 +++++++++++++++++-----------------
rdoc-sources/FXDCPrint.rb | 4 +--
rdoc-sources/FXDCWindow.rb | 2 +-
rdoc-sources/FXDialogBox.rb | 2 +-
rdoc-sources/FXDict.rb | 5 ++--
rdoc-sources/FXFileDialog.rb | 2 +-
rdoc-sources/FXFileDict.rb | 2 +-
rdoc-sources/FXFileSelector.rb | 2 +-
rdoc-sources/FXFont.rb | 2 +-
rdoc-sources/FXHeader.rb | 5 +---
rdoc-sources/FXIconList.rb | 2 +-
rdoc-sources/FXImage.rb | 22 ++++++++--------
rdoc-sources/FXList.rb | 2 +-
rdoc-sources/FXSpring.rb | 2 +-
rdoc-sources/FXStatusLine.rb | 2 +-
rdoc-sources/FXTabBar.rb | 2 +-
rdoc-sources/FXTabBook.rb | 2 +-
rdoc-sources/FXTable.rb | 12 ++++-----
rdoc-sources/FXTreeList.rb | 8 +++---
rdoc-sources/FXWindow.rb | 2 +-
24 files changed, 86 insertions(+), 90 deletions(-)
diff --git a/rdoc-sources/FX4Splitter.rb b/rdoc-sources/FX4Splitter.rb
index 0f7bf47..d7b01cd 100755
--- a/rdoc-sources/FX4Splitter.rb
+++ b/rdoc-sources/FX4Splitter.rb
@@ -129,7 +129,7 @@ module Fox
#
# Return the horizontal split fraction, an integer between 0 and
- # 10000 inclusive. See FX4Splitter#setHSplit for more information.
+ # 10000 inclusive. See {FX4Splitter#setHSplit} for more information.
#
def getHSplit(); end
@@ -149,7 +149,7 @@ module Fox
#
# Return the vertical split fraction, an integer between 0 and
- # 10000 inclusive. See FX4Splitter#setVSplit for more information.
+ # 10000 inclusive. See {FX4Splitter#setVSplit} for more information.
#
def getVSplit(); end
end
diff --git a/rdoc-sources/FXAccelTable.rb b/rdoc-sources/FXAccelTable.rb
index 7d4dbdb..2a98e2c 100755
--- a/rdoc-sources/FXAccelTable.rb
+++ b/rdoc-sources/FXAccelTable.rb
@@ -56,7 +56,7 @@ module Fox
#
# Unparse hot key comprising modifier and key code back
- # into a string suitable for parsing with #parseHotKey.
+ # into a string suitable for parsing with {#parseHotKey}.
#
def unparseAccel(key); end
diff --git a/rdoc-sources/FXApp.rb b/rdoc-sources/FXApp.rb
index dd67897..d21b7f3 100755
--- a/rdoc-sources/FXApp.rb
+++ b/rdoc-sources/FXApp.rb
@@ -94,7 +94,7 @@ module Fox
# the addSignal method, a +SEL_SIGNAL+ message may be sent to the message
# target.
#
- # === File input modes for #addInput
+ # === File input modes for {#addInput}
#
# +INPUT_NONE+:: inactive
# +INPUT_READ+:: read input fd
@@ -111,7 +111,7 @@ module Fox
#
# These constants symbolically represent the different cursor shapes used
# in FOX applications, and can be used as the _which_ arguments for
- # #getDefaultCursor and #setDefaultCursor.
+ # {#getDefaultCursor} and {#setDefaultCursor}.
#
# +DEF_ARROW_CURSOR+:: Arrow cursor
# +DEF_RARROW_CURSOR+:: Reverse arrow cursor
@@ -284,7 +284,7 @@ module Fox
end
#
- # Open connection to display; this is called by #init.
+ # Open connection to display; this is called by {#init}.
#
def openDisplay(dpyname=nil) ; end
@@ -344,8 +344,8 @@ module Fox
# Perform one event dispatch; return +true+ if event was dispatched.
def runOneEvent(blocking=true); end
- # Run the main application event loop until #stop is called,
- # and return the exit code passed as argument to #stop.
+ # Run the main application event loop until {#stop} is called,
+ # and return the exit code passed as argument to {#stop}.
def run(); end
#
@@ -363,27 +363,27 @@ module Fox
#
# Run event loop while there are events are available in the queue.
# Returns 1 when all events in the queue have been handled, and 0 when
- # the event loop was terminated due to #stop or #stopModal.
+ # the event loop was terminated due to {#stop} or {#stopModal}.
# Except for the modal window and its children, user input to all windows
# is blocked; if the modal window is +nil+, all user input is blocked.
#
def runModalWhileEvents(window=nil); end
# Run modal event loop, blocking keyboard and mouse events to all windows
- # until #stopModal is called.
+ # until {#stopModal} is called.
def runModal(); end
- # Run a modal event loop for the given window, until #stop or #stopModal is
+ # Run a modal event loop for the given window, until {#stop} or {#stopModal} is
# called. Except for the modal window and its children, user input to all
# windows is blocked; if the modal window is +nil+ all user input is blocked.
def runModalFor(window); end
- # Run modal while window is shown, or until #stop or #stopModal is called.
+ # Run modal while window is shown, or until {#stop} or {#stopModal} is called.
# Except for the modal window and its children, user input to all windows
# is blocked; if the modal window is +nil+ all user input is blocked.
def runModalWhileShown(window); end
- # Run popup menu while shown, until #stop or #stopModal is called.
+ # Run popup menu while shown, until {#stop} or {#stopModal} is called.
# Also returns when entering previous cascading popup menu.
def runPopup(window); end
@@ -443,7 +443,7 @@ module Fox
#
# yamlDragType = app.registerDragType("application/x-yaml")
#
- # See also #getDragTypeName.
+ # See also {#getDragTypeName}.
#
def registerDragType(name) ; end
@@ -452,7 +452,7 @@ module Fox
#
# dragTypeName = app.getDragTypeName(yamlDragType)
#
- # See also #registerDragType.
+ # See also {#registerDragType}.
#
def getDragTypeName(dragType) ; end
@@ -463,7 +463,7 @@ module Fox
def FXApp.instance(); end
# End the most deeply nested wait-cursor block.
- # See also #beginWaitCursor.
+ # See also {#beginWaitCursor}.
def endWaitCursor(); end
#
@@ -473,7 +473,7 @@ module Fox
#
# rotateCursor = app.getDefaultCursor(DEF_ROTATE_CURSOR)
#
- # See also #setDefaultCursor.
+ # See also {#setDefaultCursor}.
#
def getDefaultCursor(which) ; end
@@ -482,7 +482,7 @@ module Fox
#
# app.setDefaultCursor(DEF_ROTATE_CURSOR, myRotateCursor)
#
- # See also #getDefaultCursor.
+ # See also {#getDefaultCursor}.
#
def setDefaultCursor(which, cursor); end
diff --git a/rdoc-sources/FXBitmap.rb b/rdoc-sources/FXBitmap.rb
index 2f49273..d784baf 100755
--- a/rdoc-sources/FXBitmap.rb
+++ b/rdoc-sources/FXBitmap.rb
@@ -27,7 +27,7 @@ module Fox
# is set. If the +BITMAP_OWNED+ flag _is_ set, but a +nil+ value for _pixels_
# is passed in, a pixel buffer will be automatically created and will be
# owned by the bitmap. The flags +BITMAP_SHMI+ and +BITMAP_SHMP+ may be
- # specified for large bitmaps to instruct FXBitmap#render to use shared
+ # specified for large bitmaps to instruct {FXBitmap#render} to use shared
# memory to communicate with the server.
#
def initialize(app, pixels=nil, opts=0, width=1, height=1) # :yields: theBitmap
@@ -37,7 +37,7 @@ module Fox
# Populate the bitmap with new pixel data of the same size; it will assume
# ownership of the pixel data if the +BITMAP_OWNED+ option is passed in the _opts_.
# The server-side representation of the image, if it exists, is not updated;
- # to update ther server-side representation, call #render.
+ # to update ther server-side representation, call {#render}.
#
def setData(pix, opts=0); end
@@ -45,7 +45,7 @@ module Fox
# Populate the bitmap with new pixel data of a new size; it will assume ownership
# of the pixel data if the +BITMAP_OWNED+ option is passed in the _opts_. The size of the server-
# side representation of the image, if it exists, is adjusted but the contents are
- # not updated; to update the server-side representation, call #render.
+ # not updated; to update the server-side representation, call {#render}.
#
def setData(pix, opts, w, h); end
@@ -91,7 +91,7 @@ module Fox
#
# Rescale pixels image to the specified width and height; this calls
- # #resize to adjust the client and server side representations.
+ # {#resize} to adjust the client and server side representations.
#
def scale(w, h); end
@@ -102,7 +102,7 @@ module Fox
def rotate(degrees); end
#
- # Crop bitmap to given rectangle; this calls #resize to adjust the client
+ # Crop bitmap to given rectangle; this calls {#resize} to adjust the client
# and server side representations. The new bitmap may be smaller or larger
# than the old one; blank areas are filled with _color_. There must be at
# least one pixel of overlap between the old and the new bitmap.
diff --git a/rdoc-sources/FXDC.rb b/rdoc-sources/FXDC.rb
index e7b5ddf..b1c3eb3 100755
--- a/rdoc-sources/FXDC.rb
+++ b/rdoc-sources/FXDC.rb
@@ -216,7 +216,7 @@ module Fox
# +x+:: x-coordinate of the point [Integer]
# +y+:: y-coordinate of the point [Integer]
#
- # See also #drawPoints and #drawPointsRel.
+ # See also {#drawPoints} and {#drawPointsRel}.
#
def drawPoint(x, y) ; end
@@ -227,21 +227,21 @@ module Fox
#
# +points+:: array of FXPoint instances [Array]
#
- # See also #drawPoint and #drawPointsRel.
+ # See also {#drawPoint} and {#drawPointsRel}.
#
def drawPoints(points) ; end
#
# Draw multiple points, where _points_ is an array of FXPoint instances.
- # Unlike #drawPoints, where each of the points is drawn relative to the
- # origin, #drawPointsRel treats all coordinates after the first as relative
+ # Unlike {#drawPoints}, where each of the points is drawn relative to the
+ # origin, {#drawPointsRel} treats all coordinates after the first as relative
# to the previous point.
#
# ==== Parameters:
#
# +points+:: array of FXPoint instances [Array]
#
- # See also #drawPoint and #drawPoints.
+ # See also {#drawPoint} and {#drawPoints}.
#
def drawPointsRel(points) ; end
@@ -255,7 +255,7 @@ module Fox
# <tt>x2</tt>:: x-coordinate of the ending point [Integer]
# <tt>y2</tt>:: y-coordinate of the ending point [Integer]
#
- # See also #drawLines and #drawLinesRel.
+ # See also {#drawLines} and {#drawLinesRel}.
#
def drawLine(x1, y1, x2, y2) ; end
@@ -269,7 +269,7 @@ module Fox
#
# +points+:: array of FXPoint instances that defines all points on the line [Array]
#
- # See also #drawLine and #drawLinesRel.
+ # See also {#drawLine} and {#drawLinesRel}.
#
def drawLines(points) ; end
@@ -284,7 +284,7 @@ module Fox
#
# +points+:: array of FXPoint instances that defines all points on the line [Array]
#
- # See also #drawLine and #drawLines.
+ # See also {#drawLine} and {#drawLines}.
#
def drawLinesRel(points) ; end
@@ -308,7 +308,7 @@ module Fox
# +width+:: width of the rectangle, in pixels [Integer]
# +height+:: height of the rectangle, in pixels [Integer]
#
- # See also #drawRectangles, #fillRectangle and #fillRectangles.
+ # See also {#drawRectangles}, {#fillRectangle} and {#fillRectangles}.
#
def drawRectangle(x, y, w, h) ; end
@@ -319,7 +319,7 @@ module Fox
#
# +rectangles+:: an array of FXRectangle instances [Array]
#
- # See also #drawRectangle, #fillRectangle and #fillRectangles.
+ # See also {#drawRectangle}, {#fillRectangle} and {#fillRectangles}.
#
def drawRectangles(rectangles) ; end
@@ -353,7 +353,7 @@ module Fox
# <tt>start</tt>:: starting angle of the arc, in 64ths of a degree [Integer]
# <tt>extent</tt>:: the path and extent of the arc, relative to the start of the arc (in 64ths of a degree) [Integer]
#
- # See also #drawArcs, #fillArc and #fillArcs.
+ # See also {#drawArcs}, {#fillArc} and {#fillArcs}.
#
def drawArc(x, y, w, h, start, extent) ; end
@@ -364,7 +364,7 @@ module Fox
#
# +arcs+:: an array of FXArc instances [Array]
#
- # See also #drawArc, #fillArc and #fillArcs.
+ # See also {#drawArc}, {#fillArc} and {#fillArcs}.
#
def drawArcs(arcs) ; end
@@ -383,7 +383,7 @@ module Fox
# +width+:: width of the rectangle, in pixels [Integer]
# +height+:: height of the rectangle, in pixels [Integer]
#
- # See also #drawRectangle, #drawRectangles and #fillRectangles.
+ # See also {#drawRectangle}, {#drawRectangles} and {#fillRectangles}.
#
def fillRectangle(x, y, w, h) ; end
@@ -394,7 +394,7 @@ module Fox
#
# +rectangles+:: an array of FXRectangle instances [Array]
#
- # See also #drawRectangle, #drawRectangles and #fillRectangle.
+ # See also {#drawRectangle}, {#drawRectangles} and {#fillRectangle}.
#
def fillRectangles(rectangles) ; end
@@ -414,7 +414,7 @@ module Fox
def fillChords(chords, nchords) ; end
#
- # Draw filled arc (see documentation for #drawArc).
+ # Draw filled arc (see documentation for {#drawArc}).
#
# === Parameters:
#
@@ -425,7 +425,7 @@ module Fox
# <tt>start</tt>:: starting angle of the arc, in 64ths of a degree [Integer]
# <tt>extent</tt>:: the path and extent of the arc, relative to the start of the arc (in 64ths of a degree) [Integer]
#
- # See also #drawArc, #drawArcs and #fillArcs.
+ # See also {#drawArc}, {#drawArcs} and {#fillArcs}.
#
def fillArc(x, y, w, h, start, extent) ; end
@@ -436,7 +436,7 @@ module Fox
#
# +arcs+:: an array of FXArc instances [Array]
#
- # See also #drawArc, #drawArcs and #fillArc.
+ # See also {#drawArc}, {#drawArcs} and {#fillArc}.
#
def fillArcs(arcs) ; end
@@ -623,7 +623,7 @@ module Fox
# +y+:: y-coordinate of the upper left corner [Integer]
# +string+:: the text string to draw [String]
#
- # See also #drawImageText.
+ # See also {#drawImageText}.
#
def drawText(x, y, string) ; end
@@ -636,7 +636,7 @@ module Fox
# +y+:: y-coordinate of the upper left corner [Integer]
# +string+:: the text string to draw [String]
#
- # See also #drawText.
+ # See also {#drawText}.
#
def drawImageText(x, y, string) ; end
@@ -664,7 +664,7 @@ module Fox
# +width+:: width of the clip rectangle, in pixels [Integer]
# +height+:: height of the clip rectangle, in pixels [Integer]
#
- # See also #setClipMask.
+ # See also {#setClipMask}.
#
def setClipRectangle(x, y, w, h) ; end
@@ -675,7 +675,7 @@ module Fox
#
# +rectangle+:: a rectangle that defines the clipping region [Integer]
#
- # See also #setClipMask.
+ # See also {#setClipMask}.
#
def setClipRectangle(rectangle) ; end
@@ -693,7 +693,7 @@ module Fox
# +dx+:: [Integer]
# +dy+:: [Integer]
#
- # See also #setClipRectangle.
+ # See also {#setClipRectangle}.
#
def setClipMask(bitmap, dx=0, dy=0) ; end
@@ -703,10 +703,10 @@ module Fox
def clearClipMask() ; end
#
- # When you call #clipChildren with the argument +true+, anything that you
+ # When you call {#clipChildren} with the argument +true+, anything that you
# draw into this window will be clipped by its child windows. In other words,
# the child windows "obscure" the parent window. This is the default behavior.
- # If you call #clipChildren with +false+, anything that you draw into this
+ # If you call {#clipChildren} with +false+, anything that you draw into this
# window will be visible in its child windows (i.e. the drawing will *not*
# be clipped).
#
diff --git a/rdoc-sources/FXDCPrint.rb b/rdoc-sources/FXDCPrint.rb
index 890ce9f..b15607c 100755
--- a/rdoc-sources/FXDCPrint.rb
+++ b/rdoc-sources/FXDCPrint.rb
@@ -111,13 +111,13 @@ module Fox
#
# Generate print job epilog.
- # See also #beginPrint.
+ # See also {#beginPrint}.
#
def endPrint(); end
#
# Generate end of page.
- # See also #beginPage.
+ # See also {#beginPage}.
#
def endPage(); end
diff --git a/rdoc-sources/FXDCWindow.rb b/rdoc-sources/FXDCWindow.rb
index fcd190c..d5eca27 100755
--- a/rdoc-sources/FXDCWindow.rb
+++ b/rdoc-sources/FXDCWindow.rb
@@ -14,7 +14,7 @@ module Fox
# If _event_ is a reference to an FXEvent, the device context is constructed for
# painting in response to an expose; this sets the clip rectangle to the exposed rectangle.
# If an optional code block is provided, the new device context will be passed into the block as an
- # argument and #end will be called automatically when the block terminates.
+ # argument and {#end} will be called automatically when the block terminates.
#
def initialize(drawable, event=nil) # :yields: dc
end
diff --git a/rdoc-sources/FXDialogBox.rb b/rdoc-sources/FXDialogBox.rb
index e34d360..04bd4db 100755
--- a/rdoc-sources/FXDialogBox.rb
+++ b/rdoc-sources/FXDialogBox.rb
@@ -7,7 +7,7 @@ module Fox
# loop and returns a completion code of either 0 or 1, respectively.
#
# To close a dialog box when it's not running modally, simply call
- # FXDialogBox#hide (or send it the +ID_HIDE+ command message).
+ # {#hide} (or send it the +ID_HIDE+ command message).
#
# === Message identifiers
#
diff --git a/rdoc-sources/FXDict.rb b/rdoc-sources/FXDict.rb
index 2e914bc..6467af7 100755
--- a/rdoc-sources/FXDict.rb
+++ b/rdoc-sources/FXDict.rb
@@ -2,9 +2,8 @@ module Fox
#
# The dictionary class maintains a fast-access hash table of entities
# indexed by a character string.
- # It is typically used to map strings to pointers; however, overloading
- # the #createData and #deleteData members allows any type of data to
- # be indexed by strings.
+ # It is typically used to map strings to pointers; however, derived classes
+ # may allow any type of data to be indexed by strings.
#
class FXDict < FXObject
diff --git a/rdoc-sources/FXFileDialog.rb b/rdoc-sources/FXFileDialog.rb
index a79a16d..5af1444 100755
--- a/rdoc-sources/FXFileDialog.rb
+++ b/rdoc-sources/FXFileDialog.rb
@@ -83,7 +83,7 @@ module Fox
#
# will both set the same three patterns, but the former shows no pattern names.
#
- # For compatibility with the FOX C++ library API of the same name, #setPatternList
+ # For compatibility with the FOX C++ library API of the same name, {#setPatternList}
# also accepts a _patterns_ value that is a single string, with each pattern
# separated by newline characters, e.g.
#
diff --git a/rdoc-sources/FXFileDict.rb b/rdoc-sources/FXFileDict.rb
index bcaa41c..358cfd3 100755
--- a/rdoc-sources/FXFileDict.rb
+++ b/rdoc-sources/FXFileDict.rb
@@ -24,7 +24,7 @@ module Fox
# Mini open icon {FXIcon}
attr_accessor :miniiconopen
- # Registered drag type {FXDragType}
+ # Registered drag type [Integer]
attr_accessor :dragtype
# Flags [Integer]
diff --git a/rdoc-sources/FXFileSelector.rb b/rdoc-sources/FXFileSelector.rb
index 8d9b381..93e0061 100755
--- a/rdoc-sources/FXFileSelector.rb
+++ b/rdoc-sources/FXFileSelector.rb
@@ -104,7 +104,7 @@ module Fox
#
# will both set the same three patterns, but the former shows no pattern names.
#
- # For compatibility with the FOX C++ library API of the same name, #setPatternList
+ # For compatibility with the FOX C++ library API of the same name, {#setPatternList}
# also accepts a _patterns_ value that is a single string, with each pattern
# separated by newline characters, e.g.
#
diff --git a/rdoc-sources/FXFont.rb b/rdoc-sources/FXFont.rb
index bb95bb5..b73dd4a 100755
--- a/rdoc-sources/FXFont.rb
+++ b/rdoc-sources/FXFont.rb
@@ -305,7 +305,7 @@ module Fox
#
# Return the font description as a string suitable for
- # parsing with #setFont, see above.
+ # parsing with {#setFont}, see above.
#
def getFont(); end
diff --git a/rdoc-sources/FXHeader.rb b/rdoc-sources/FXHeader.rb
index 22c52df..ad21d88 100755
--- a/rdoc-sources/FXHeader.rb
+++ b/rdoc-sources/FXHeader.rb
@@ -190,7 +190,7 @@ module Fox
#
# Replace the item at _index_ with a new item with the specified
# text, icon, size and user data object, and return the index of the replaced
- # item. The new item is created by calling the FXHeader#createItem method.
+ # item.
# If _notify_ is +true+, a +SEL_REPLACED+ message is sent to the header's
# message target before the item is replaced.
# Raises IndexError if _index_ is out of bounds.
@@ -215,7 +215,6 @@ module Fox
#
# Insert a new item at the specified _index_ with the specified text, icon, size
# and user data object, and return the index of the inserted item.
- # The new item is created by calling the FXHeader#createItem method.
# If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the header's
# message target after the item is inserted.
# Raises IndexError if _index_ is out of bounds.
@@ -233,7 +232,6 @@ module Fox
#
# Append a new item with the specified text, icon, size and user data object,
# and return the index of the appended item.
- # The new item is created by calling the FXHeader#createItem method.
# If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the header's
# message target after the item is appended.
#
@@ -250,7 +248,6 @@ module Fox
#
# Prepend a new item with the specified text, icon, size and user data object,
# and return the index of the appended item.
- # The new item is created by calling the FXHeader#createItem method.
# If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the header's
# message target after the item is appended.
#
diff --git a/rdoc-sources/FXIconList.rb b/rdoc-sources/FXIconList.rb
index e113233..5cdbca2 100755
--- a/rdoc-sources/FXIconList.rb
+++ b/rdoc-sources/FXIconList.rb
@@ -333,7 +333,7 @@ module Fox
#
# Scroll to bring item into view. The argument is either a reference to
# an FXIconItem instance, or the integer index of an item in the list.
- # For the latter case, #makeItemVisible raises IndexError if the index
+ # For the latter case, {#makeItemVisible} raises IndexError if the index
# is out of bounds.
#
def makeItemVisible(itemOrIndex); end
diff --git a/rdoc-sources/FXImage.rb b/rdoc-sources/FXImage.rb
index d539128..5087489 100755
--- a/rdoc-sources/FXImage.rb
+++ b/rdoc-sources/FXImage.rb
@@ -55,7 +55,7 @@ module Fox
# If the +IMAGE_OWNED+ flag is set but a +nil+ pixel buffer is
# passed, a pixel buffer will be automatically created and will be owned
# by the image. The flags +IMAGE_SHMI+ and +IMAGE_SHMP+ may be specified for
- # large images to instruct #render to use shared memory to communicate
+ # large images to instruct {#render} to use shared memory to communicate
# with the server.
#
# ==== Parameters:
@@ -122,7 +122,7 @@ module Fox
# Restore client-side pixel buffer from image.
# This operation overwrites any current values for the client-side
# pixel buffer with values corresponding to the server-side image.
- # If the image data is +nil+ at the time #restore is called, the
+ # If the image data is +nil+ at the time {#restore} is called, the
# image will first allocate an (owned) pixel buffer to use for this
# operation.
#
@@ -149,9 +149,9 @@ module Fox
# transform the image.
#
# The optional third argument specifies the _quality_ of the scaling algorithm
- # used. By default, #scale uses a fast (but low quality) nearest-neighbor algorithm
+ # used. By default, {#scale} uses a fast (but low quality) nearest-neighbor algorithm
# for scaling the image to its new size. To use the higher-quality scaling algorithm
- # from FOX 1.0, you should pass in a value of 1 as the third argument to #scale.
+ # from FOX 1.0, you should pass in a value of 1 as the third argument to {#scale}.
#
# ==== Parameters:
#
@@ -285,12 +285,12 @@ module Fox
# Save pixel data to a stream.
#
# Note that the base class version of
- # #savePixels saves the pixel data as-is, without any image format
+ # {#savePixels} saves the pixel data as-is, without any image format
# specific information. For example, if you have a 1024x768 image
# without an alpha channel (and thus only the red, green and blue
# channels) the total number of bytes written to the stream will be
- # 1024*768*3*8. The behavior of #savePixels is different for subclasses
- # such as FXPNGImage, where #savePixels will instead save the image
+ # 1024*768*3*8. The behavior of {#savePixels} is different for subclasses
+ # such as FXPNGImage, where {#savePixels} will instead save the image
# data in a specific image file format (i.e. the PNG file format).
#
# ==== Parameters:
@@ -303,12 +303,12 @@ module Fox
# Load pixel data from a stream.
#
# Note that the base class version of
- # #loadPixels expects to read the the pixel data in a neutral format
+ # {#loadPixels} expects to read the the pixel data in a neutral format
# (i.e. without any image format specific information). For example, if
# you have a 1024x768 image without an alpha channel (and thus only the
- # red, green and blue channels), #loadPixels will attempt to read a total
- # of 1024*768*3*8 bytes from the stream. The behavior of #loadPixels is
- # different for subclasses such as FXPNGImage, where #loadPixels will instead
+ # red, green and blue channels), {#loadPixels} will attempt to read a total
+ # of 1024*768*3*8 bytes from the stream. The behavior of {#loadPixels} is
+ # different for subclasses such as FXPNGImage, where {#loadPixels} will instead
# expects to read the image data in a specific image file format (i.e. the
# PNG file format).
#
diff --git a/rdoc-sources/FXList.rb b/rdoc-sources/FXList.rb
index c3504fe..e00980c 100755
--- a/rdoc-sources/FXList.rb
+++ b/rdoc-sources/FXList.rb
@@ -303,7 +303,7 @@ module Fox
#
# Scroll to bring item into view. The argument is either a reference to
# an FXListItem instance, or the integer index of an item in the list.
- # For the latter case, #makeItemVisible raises IndexError if the index
+ # For the latter case, {#makeItemVisible} raises IndexError if the index
# is out of bounds.
#
def makeItemVisible(itemOrIndex) ; end
diff --git a/rdoc-sources/FXSpring.rb b/rdoc-sources/FXSpring.rb
index 29c2e65..7fe223b 100755
--- a/rdoc-sources/FXSpring.rb
+++ b/rdoc-sources/FXSpring.rb
@@ -6,7 +6,7 @@ module Fox
#
# The third and fourth arguments to the FXSpring.new method (+relw+ and +relh+)
# determine the "length" of the spring. You can also change these settings after
- # the widget is constructed using the FXSpring#relativeWidth and FXSpring#relativeHeight
+ # the widget is constructed using the {FXSpring#relativeWidth} and {FXSpring#relativeHeight}
# accessor methods.
# The actual length that you specify is not really
# important; the only thing that counts is the relative length of one
diff --git a/rdoc-sources/FXStatusLine.rb b/rdoc-sources/FXStatusLine.rb
index d8df1f5..33471e8 100755
--- a/rdoc-sources/FXStatusLine.rb
+++ b/rdoc-sources/FXStatusLine.rb
@@ -8,7 +8,7 @@ module Fox
# If this query does not result in a new status string, the target of
# the status line is tried via an ordinary +SEL_UPDATE+ message.
# If _none_ of the above work, the status line will display the normal text
- # (i.e. the string set via the #normalText= accessor method).
+ # (i.e. the string set via the {#normalText}= accessor method).
# If the message contains a newline character, then the part before the newline
# will be displayed in the highlight color, while the part after the newline
# will be shown using the normal text color.
diff --git a/rdoc-sources/FXTabBar.rb b/rdoc-sources/FXTabBar.rb
index b97cca8..3cb133a 100755
--- a/rdoc-sources/FXTabBar.rb
+++ b/rdoc-sources/FXTabBar.rb
@@ -5,7 +5,7 @@ module Fox
# In a the horizontal arrangement, the tab bar can have the tab
# items on the top or on the bottom. In the vertical arrangement,
# the tabs can be on the left or on the right.
- # When one of the tab items is pressed, the tab bar's #setCurrent()
+ # When one of the tab items is pressed, the tab bar's {#setCurrent}()
# method is called with _notify_ of +true+. This in turn causes the tab bar
# to send a +SEL_COMMAND+ message to its target.
#
diff --git a/rdoc-sources/FXTabBook.rb b/rdoc-sources/FXTabBook.rb
index 026f241..51cc486 100755
--- a/rdoc-sources/FXTabBook.rb
+++ b/rdoc-sources/FXTabBook.rb
@@ -11,7 +11,7 @@ module Fox
# Thus, a tab book can be used to present many GUI controls
# in a small space by placing several panels on top of each
# other and using tab items to select the desired panel.
- # When one of the tab items is pressed, the tab book's #setCurrent method
+ # When one of the tab items is pressed, the tab book's {#setCurrent} method
# is called with _notify+=true. This causes the tab book to send a
# +SEL_COMMAND+ message to its target.
#
diff --git a/rdoc-sources/FXTable.rb b/rdoc-sources/FXTable.rb
index 7ac334b..88b8b57 100755
--- a/rdoc-sources/FXTable.rb
+++ b/rdoc-sources/FXTable.rb
@@ -433,13 +433,13 @@ module Fox
#
# Show or hide horizontal grid.
- # Note that this is equivalent to the #horizontalGridShown=() method.
+ # Note that this is equivalent to the {#horizontalGridShown=} method.
#
def showHorzGrid(on=true) ; end
#
# Show or hide vertical grid.
- # Note that this is equivalent to the #verticalGridShown=() method.
+ # Note that this is equivalent to the {#verticalGridShown=} method.
#
def showVertGrid(on=true) ; end
@@ -739,7 +739,7 @@ module Fox
# the string specified by _cs_, and each row is delimited by
# the string specified by _rs_.
# To reverse this operation (i.e. set the table cells' text
- # from a string), see #overlayText.
+ # from a string), see {#overlayText}.
# Raises IndexError if any of _startrow_, _endrow_, _startcol_
# or _endcol_ is out of bounds.
#
@@ -761,7 +761,7 @@ module Fox
# the character specified by _cs_, and each row should be delimited by
# the character specified by _rs_.
# To reverse this operation (i.e. extract the table cells' text
- # into a string), see #extractText.
+ # into a string), see {#extractText}.
# Raises IndexError if any of _startrow_, _endrow_, _startcol_
# or _endcol_ is out of bounds.
#
@@ -936,7 +936,7 @@ module Fox
# If the value is zero, this background color is used for even-numbered
# rows (columns). If the value is one, this background color is used
# for odd-numbered rows (columns).
- # See also #getCellColor.
+ # See also {#getCellColor}.
#
def setCellColor(row, column, color) ; end
@@ -946,7 +946,7 @@ module Fox
# If the value is zero, returns the background color used for even-numbered
# rows (columns). If the value is one, returns the background color used
# for odd-numbered rows (columns).
- # See also #setCellColor.
+ # See also {#setCellColor}.
#
def getCellColor(row, column) ; end
diff --git a/rdoc-sources/FXTreeList.rb b/rdoc-sources/FXTreeList.rb
index 276fbb5..63ba192 100755
--- a/rdoc-sources/FXTreeList.rb
+++ b/rdoc-sources/FXTreeList.rb
@@ -3,8 +3,8 @@ module Fox
# Each item in an FXTreeList is an instance of FXTreeItem.
#
# A tree item can contain zero or more child items, and those items are arranged
- # as a linked list. The FXTreeItem#first method returns the a reference to the
- # first child item, if any, and the FXTreeItem#last method returns a reference to
+ # as a linked list. The {FXTreeItem#first} method returns the a reference to the
+ # first child item, if any, and the {FXTreeItem#last} method returns a reference to
# the last child item.
#
class FXTreeItem < FXObject
@@ -455,7 +455,7 @@ module Fox
#
# Set this item's state to opened. The primary result of this change is
# that the item's icon will change to its "open" icon.
- # This is different from the #expandTree method, which actually
+ # This is different from the {#expandTree} method, which actually
# collapses part of the tree list, making some items invisible.
# If _notify_ is +true+, a +SEL_OPENED+ message is sent to the list's
# message target after the item is opened.
@@ -465,7 +465,7 @@ module Fox
#
# Set this item's state to closed. The primary result of this change is
# that the item's icon will change to its "closed" icon.
- # This is different from the #collapseTree method, which actually
+ # This is different from the {#collapseTree} method, which actually
# collapses part of the tree list, making some items invisible.
# If _notify_ is +true+, a +SEL_CLOSED+ message is sent to the list's
# message target after the item is closed.
diff --git a/rdoc-sources/FXWindow.rb b/rdoc-sources/FXWindow.rb
index a33f2c5..cbbf05a 100755
--- a/rdoc-sources/FXWindow.rb
+++ b/rdoc-sources/FXWindow.rb
@@ -663,7 +663,7 @@ module Fox
# This function notifies the drag source that its part of the drop transaction
# is finished, and that it is free to release any resources involved in the
# drag operation.
- # Calling #dropFinished is advisable in cases where the drop target needs
+ # Calling {#dropFinished} is advisable in cases where the drop target needs
# to perform complex processing on the data received from the drag source,
# prior to returning from the +SEL_DND_DROP+ message handler.
#
--
GitLab