Permalink
Browse files

Adjust more rdoc links, so that they work with yard

Remove some comments, to only from C++ usable methods
  • Loading branch information...
1 parent 11426d0 commit 625b4298f67c1da6868701972cad884508cbb8e8 @larskanis committed Mar 7, 2012
@@ -129,7 +129,7 @@ def setHSplit(s); end
#
# 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 @@ def setVSplit(s); end
#
# 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
@@ -56,7 +56,7 @@ def parseAccel(string); end
#
# 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
View
@@ -94,7 +94,7 @@ def synthetic? ; end
# 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 @@ def synthetic? ; end
#
# 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 @@ def initialize(appName="Application", vendorName="FoxDefault") # :yields: theApp
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 @@ def peekEvent(); end
# 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 @@ def runWhileEvents(); end
#
# 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 @@ def exit(code=0); end
#
# yamlDragType = app.registerDragType("application/x-yaml")
#
- # See also #getDragTypeName.
+ # See also {#getDragTypeName}.
#
def registerDragType(name) ; end
@@ -452,7 +452,7 @@ def registerDragType(name) ; end
#
# dragTypeName = app.getDragTypeName(yamlDragType)
#
- # See also #registerDragType.
+ # See also {#registerDragType}.
#
def getDragTypeName(dragType) ; end
@@ -463,7 +463,7 @@ def beep(); end
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 @@ def endWaitCursor(); end
#
# rotateCursor = app.getDefaultCursor(DEF_ROTATE_CURSOR)
#
- # See also #setDefaultCursor.
+ # See also {#setDefaultCursor}.
#
def getDefaultCursor(which) ; end
@@ -482,7 +482,7 @@ def getDefaultCursor(which) ; end
#
# app.setDefaultCursor(DEF_ROTATE_CURSOR, myRotateCursor)
#
- # See also #getDefaultCursor.
+ # See also {#getDefaultCursor}.
#
def setDefaultCursor(which, cursor); end
View
@@ -27,7 +27,7 @@ class FXBitmap < FXDrawable
# 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,15 +37,15 @@ def initialize(app, pixels=nil, opts=0, width=1, height=1) # :yields: theBitmap
# 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
#
# 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 @@ def setPixel(x, y, color) ; end
#
# 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 @@ def mirror(horizontal, vertical); end
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.
View
@@ -216,7 +216,7 @@ def readPixel(x, y) ; end
# +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 @@ def drawPoint(x, y) ; end
#
# +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 @@ def drawPointsRel(points) ; end
# <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 @@ def drawLine(x1, y1, x2, y2) ; end
#
# +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 @@ def drawLines(points) ; end
#
# +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 @@ def drawLineSegments(segments) ; end
# +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 @@ def drawRectangle(x, y, w, h) ; end
#
# +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 @@ def drawRoundRectangle(x, y, w, h, ew, eh); end
# <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 @@ def drawArc(x, y, w, h, start, extent) ; end
#
# +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 @@ def drawEllipse(x, y, w, h); end
# +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 @@ def fillRectangle(x, y, w, h) ; end
#
# +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 @@ def fillChord(x, y, w, h, ang1, ang2) ; end
def fillChords(chords, nchords) ; end
#
- # Draw filled arc (see documentation for #drawArc).
+ # Draw filled arc (see documentation for {#drawArc}).
#
# === Parameters:
#
@@ -425,7 +425,7 @@ def fillChords(chords, nchords) ; end
# <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 @@ def fillArc(x, y, w, h, start, extent) ; end
#
# +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 @@ def drawIconSunken(icon, dx, dy) ; end
# +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 @@ def drawText(x, y, string) ; end
# +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 @@ def setDashes(dashOffset, dashPattern) ; end
# +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 @@ def setClipRectangle(x, y, w, h) ; end
#
# +rectangle+:: a rectangle that defines the clipping region [Integer]
#
- # See also #setClipMask.
+ # See also {#setClipMask}.
#
def setClipRectangle(rectangle) ; end
@@ -693,7 +693,7 @@ def clearClipRectangle() ; end
# +dx+:: [Integer]
# +dy+:: [Integer]
#
- # See also #setClipRectangle.
+ # See also {#setClipRectangle}.
#
def setClipMask(bitmap, dx=0, dy=0) ; end
@@ -703,10 +703,10 @@ def setClipMask(bitmap, dx=0, dy=0) ; end
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).
#
Oops, something went wrong.

0 comments on commit 625b429

Please sign in to comment.