From 936def8a078100389cde028a7700057261df431c Mon Sep 17 00:00:00 2001 From: Lars Kanis <kanis@comcard.de> Date: Thu, 1 Mar 2012 17:31:09 +0100 Subject: [PATCH] Adjust inner rdoc links, so that they work with yard --- rdoc-sources/FX4Splitter.rb | 14 ++++---- rdoc-sources/FX7Segment.rb | 2 +- rdoc-sources/FXApp.rb | 54 +++++++++++++++---------------- rdoc-sources/FXArrowButton.rb | 2 +- rdoc-sources/FXBMPIcon.rb | 10 +++--- rdoc-sources/FXBMPImage.rb | 2 +- rdoc-sources/FXBitmapFrame.rb | 6 ++-- rdoc-sources/FXBitmapView.rb | 6 ++-- rdoc-sources/FXCheckButton.rb | 4 +-- rdoc-sources/FXChoiceBox.rb | 4 +-- rdoc-sources/FXColorDialog.rb | 2 +- rdoc-sources/FXColorList.rb | 2 +- rdoc-sources/FXColorSelector.rb | 6 ++-- rdoc-sources/FXColorWell.rb | 2 +- rdoc-sources/FXColorWheel.rb | 4 +-- rdoc-sources/FXComboBox.rb | 14 ++++---- rdoc-sources/FXDC.rb | 30 ++++++++--------- rdoc-sources/FXDataTarget.rb | 2 +- rdoc-sources/FXDelegator.rb | 2 +- rdoc-sources/FXDial.rb | 6 ++-- rdoc-sources/FXDirBox.rb | 2 +- rdoc-sources/FXDirList.rb | 4 +-- rdoc-sources/FXDirSelector.rb | 4 +-- rdoc-sources/FXDockBar.rb | 6 ++-- rdoc-sources/FXDockSite.rb | 10 +++--- rdoc-sources/FXDockTitle.rb | 4 +-- rdoc-sources/FXDragCorner.rb | 4 +-- rdoc-sources/FXDrawable.rb | 2 +- rdoc-sources/FXDriveBox.rb | 2 +- rdoc-sources/FXFileDialog.rb | 8 ++--- rdoc-sources/FXFileDict.rb | 18 +++++------ rdoc-sources/FXFileList.rb | 4 +-- rdoc-sources/FXFileSelector.rb | 4 +-- rdoc-sources/FXFoldingList.rb | 44 ++++++++++++------------- rdoc-sources/FXFont.rb | 8 ++--- rdoc-sources/FXFontDialog.rb | 2 +- rdoc-sources/FXFontSelector.rb | 6 ++-- rdoc-sources/FXFrame.rb | 8 ++--- rdoc-sources/FXGIFCursor.rb | 4 +-- rdoc-sources/FXGIFIcon.rb | 4 +-- rdoc-sources/FXGIFImage.rb | 2 +- rdoc-sources/FXGLContext.rb | 2 +- rdoc-sources/FXGLObject.rb | 6 ++-- rdoc-sources/FXGLShape.rb | 2 +- rdoc-sources/FXGLViewer.rb | 44 ++++++++++++------------- rdoc-sources/FXGradientBar.rb | 6 ++-- rdoc-sources/FXGroupBox.rb | 4 +-- rdoc-sources/FXHeader.rb | 6 ++-- rdoc-sources/FXHorizontalFrame.rb | 2 +- rdoc-sources/FXICOIcon.rb | 10 +++--- rdoc-sources/FXICOImage.rb | 2 +- rdoc-sources/FXIcon.rb | 6 ++-- rdoc-sources/FXIconList.rb | 14 ++++---- rdoc-sources/FXId.rb | 2 +- rdoc-sources/FXImage.rb | 36 ++++++++++----------- rdoc-sources/FXImageFrame.rb | 6 ++-- rdoc-sources/FXImageView.rb | 2 +- rdoc-sources/FXJPGIcon.rb | 10 +++--- rdoc-sources/FXJPGImage.rb | 2 +- rdoc-sources/FXKnob.rb | 2 +- rdoc-sources/FXLabel.rb | 6 ++-- rdoc-sources/FXList.rb | 10 +++--- rdoc-sources/FXListBox.rb | 10 +++--- rdoc-sources/FXMDIChild.rb | 20 ++++++------ rdoc-sources/FXMDIClient.rb | 2 +- rdoc-sources/FXMemoryStream.rb | 2 +- rdoc-sources/FXMenuButton.rb | 2 +- rdoc-sources/FXMenuCaption.rb | 14 ++++---- rdoc-sources/FXMenuCascade.rb | 2 +- rdoc-sources/FXMenuCheck.rb | 2 +- rdoc-sources/FXMenuRadio.rb | 2 +- rdoc-sources/FXMenuSeparator.rb | 4 +-- rdoc-sources/FXMenuTitle.rb | 2 +- rdoc-sources/FXOptionMenu.rb | 8 ++--- rdoc-sources/FXPCXIcon.rb | 10 +++--- rdoc-sources/FXPCXImage.rb | 2 +- rdoc-sources/FXPNGIcon.rb | 10 +++--- rdoc-sources/FXPNGImage.rb | 2 +- rdoc-sources/FXPPMIcon.rb | 4 +-- rdoc-sources/FXPPMImage.rb | 2 +- rdoc-sources/FXPacker.rb | 8 ++--- rdoc-sources/FXPopup.rb | 10 +++--- rdoc-sources/FXPrintDialog.rb | 2 +- rdoc-sources/FXProgressBar.rb | 10 +++--- rdoc-sources/FXQuatd.rb | 14 ++++---- rdoc-sources/FXQuatf.rb | 20 ++++++------ rdoc-sources/FXRGBIcon.rb | 10 +++--- rdoc-sources/FXRGBImage.rb | 2 +- rdoc-sources/FXRadioButton.rb | 4 +-- rdoc-sources/FXRanged.rb | 4 +-- rdoc-sources/FXRangef.rb | 4 +-- rdoc-sources/FXRealSlider.rb | 6 ++-- rdoc-sources/FXRealSpinner.rb | 18 +++++------ rdoc-sources/FXRecentFiles.rb | 4 +-- rdoc-sources/FXRectangle.rb | 8 ++--- rdoc-sources/FXReplaceDialog.rb | 4 +-- rdoc-sources/FXRootWindow.rb | 4 +-- rdoc-sources/FXRuler.rb | 4 +-- rdoc-sources/FXRulerView.rb | 10 +++--- rdoc-sources/FXScrollArea.rb | 6 ++-- rdoc-sources/FXScrollBar.rb | 10 +++--- rdoc-sources/FXScrollPane.rb | 2 +- rdoc-sources/FXScrollWindow.rb | 2 +- rdoc-sources/FXSearchDialog.rb | 4 +-- rdoc-sources/FXSeparator.rb | 4 +-- rdoc-sources/FXSettings.rb | 4 +-- rdoc-sources/FXShutter.rb | 12 +++---- rdoc-sources/FXSlider.rb | 6 ++-- rdoc-sources/FXSphered.rb | 2 +- rdoc-sources/FXSpheref.rb | 2 +- rdoc-sources/FXSpinner.rb | 18 +++++------ rdoc-sources/FXSplashWindow.rb | 2 +- rdoc-sources/FXSplitter.rb | 6 ++-- rdoc-sources/FXSpring.rb | 2 +- rdoc-sources/FXStatusBar.rb | 6 ++-- rdoc-sources/FXStatusLine.rb | 10 +++--- rdoc-sources/FXStream.rb | 4 +-- rdoc-sources/FXSwitcher.rb | 2 +- rdoc-sources/FXTGAIcon.rb | 8 ++--- rdoc-sources/FXTGAImage.rb | 2 +- rdoc-sources/FXTIFIcon.rb | 10 +++--- rdoc-sources/FXTIFImage.rb | 2 +- rdoc-sources/FXTabBar.rb | 4 +-- rdoc-sources/FXTabBook.rb | 4 +-- rdoc-sources/FXTabItem.rb | 4 +-- rdoc-sources/FXTable.rb | 44 ++++++++++++------------- rdoc-sources/FXText.rb | 38 +++++++++++----------- rdoc-sources/FXTextField.rb | 12 +++---- rdoc-sources/FXToggleButton.rb | 10 +++--- rdoc-sources/FXToolBar.rb | 6 ++-- rdoc-sources/FXToolBarGrip.rb | 6 ++-- rdoc-sources/FXToolBarShell.rb | 10 +++--- rdoc-sources/FXToolBarTab.rb | 6 ++-- rdoc-sources/FXTopWindow.rb | 4 +-- rdoc-sources/FXTranslator.rb | 2 +- rdoc-sources/FXTreeList.rb | 24 +++++++------- rdoc-sources/FXTreeListBox.rb | 12 +++---- rdoc-sources/FXTriStateButton.rb | 12 +++---- rdoc-sources/FXVerticalFrame.rb | 2 +- rdoc-sources/FXVisual.rb | 6 ++-- rdoc-sources/FXWindow.rb | 38 +++++++++++----------- rdoc-sources/FXWizard.rb | 14 ++++---- rdoc-sources/FXXBMIcon.rb | 4 +-- rdoc-sources/FXXBMImage.rb | 2 +- rdoc-sources/FXXPMIcon.rb | 10 +++--- rdoc-sources/FXXPMImage.rb | 2 +- 146 files changed, 576 insertions(+), 576 deletions(-) diff --git a/rdoc-sources/FX4Splitter.rb b/rdoc-sources/FX4Splitter.rb index 3bb34c2..0f7bf47 100755 --- a/rdoc-sources/FX4Splitter.rb +++ b/rdoc-sources/FX4Splitter.rb @@ -68,16 +68,16 @@ module Fox # Currently expanded child (some combination of the expansion flags, or zero if no panes are expanded) attr_accessor :expanded - # Top left child window, if any [FXWindow] + # Top left child window, if any {FXWindow} attr_reader :topLeft - # Top right child window, if any [FXWindow] + # Top right child window, if any {FXWindow} attr_reader :topRight - # Bottom left child window, if any [FXWindow] + # Bottom left child window, if any {FXWindow} attr_reader :bottomLeft - # Bottom right child window, if any [FXWindow] + # Bottom right child window, if any {FXWindow} attr_reader :bottomRight # @@ -85,7 +85,7 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this splitter [FXComposite] + # +p+:: the parent widget for this splitter {FXComposite} # +opts+:: the options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] @@ -101,8 +101,8 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this splitter [FXComposite] - # +target+:: message target [FXObject] + # +p+:: the parent widget for this splitter {FXComposite} + # +target+:: message target {FXObject} # +selector+:: message identifier [Integer] # +opts+:: the options [Integer] # +x+:: initial x-position [Integer] diff --git a/rdoc-sources/FX7Segment.rb b/rdoc-sources/FX7Segment.rb index bee8351..6365384 100644 --- a/rdoc-sources/FX7Segment.rb +++ b/rdoc-sources/FX7Segment.rb @@ -13,7 +13,7 @@ module Fox # The text for this label [String] attr_accessor :text - # The text color [FXColor] + # The text color {FXColor} attr_accessor :textColor # Cell width, in pixels [Integer] diff --git a/rdoc-sources/FXApp.rb b/rdoc-sources/FXApp.rb index 442195a..dd67897 100755 --- a/rdoc-sources/FXApp.rb +++ b/rdoc-sources/FXApp.rb @@ -163,67 +163,67 @@ module Fox # Display [Integer] attr_reader :display - # Border color [FXColor] + # Border color {FXColor} attr_accessor :borderColor - # Background color of GUI controls [FXColor] + # Background color of GUI controls {FXColor} attr_accessor :baseColor - # Hilite color of GUI controls [FXColor] + # Hilite color of GUI controls {FXColor} attr_accessor :hiliteColor - # Shadow color of GUI controls [FXColor] + # Shadow color of GUI controls {FXColor} attr_accessor :shadowColor - # Default background color [FXColor] + # Default background color {FXColor} attr_accessor :backColor - # Default foreground color [FXColor] + # Default foreground color {FXColor} attr_accessor :foreColor - # Default foreground color for selected objects [FXColor] + # Default foreground color for selected objects {FXColor} attr_accessor :selforeColor - # Default background color for selected objects [FXColor] + # Default background color for selected objects {FXColor} attr_accessor :selbackColor - # Default foreground color for tooltips [FXColor] + # Default foreground color for tooltips {FXColor} attr_accessor :tipforeColor - # Default background color for tooltips [FXColor] + # Default background color for tooltips {FXColor} attr_accessor :tipbackColor - # Default text color for selected menu items [FXColor] + # Default text color for selected menu items {FXColor} attr_accessor :selMenuTextColor - # Default background color for selected menu items [FXColor] + # Default background color for selected menu items {FXColor} attr_accessor :selMenuBackColor - # Default visual [FXVisual] + # Default visual {FXVisual} attr_accessor :defaultVisual - # Default font [FXFont] + # Default font {FXFont} attr_accessor :normalFont - # Wait cursor [FXCursor] + # Wait cursor {FXCursor} attr_accessor :waitCursor - # Monochrome visual [FXVisual] + # Monochrome visual {FXVisual} attr_reader :monoVisual - # Root window [FXRootWindow] + # Root window {FXRootWindow} attr_reader :rootWindow - # The window under the cursor, if any [FXWindow] + # The window under the cursor, if any {FXWindow} attr_reader :cursorWindow - # The window at the end of the focus chain, if any [FXWindow] + # The window at the end of the focus chain, if any {FXWindow} attr_reader :focusWindow - # The active top-level window, if any [FXWindow] + # The active top-level window, if any {FXWindow} attr_reader :activeWindow - # The window of the current modal loop [FXWindow] + # The window of the current modal loop {FXWindow} attr_reader :modalWindow # Mode of current modal loop [Integer] @@ -269,7 +269,7 @@ module Fox # Amount of time (in milliseconds) to yield to Ruby's thread scheduler [Integer] attr_accessor :sleepTime - # Message translator [FXTranslator] + # Message translator {FXTranslator} attr_accessor :translator # Copyright notice for library @@ -492,8 +492,8 @@ module Fox # # ==== Parameters: # - # +store+:: [FXStream] - # +window+:: [FXWindow] + # +store+:: {FXStream} + # +window+:: {FXWindow} # def writeWindow(store, window); end @@ -504,9 +504,9 @@ module Fox # # ==== Parameters: # - # +store+:: [FXStream] - # +father+:: [FXWindow] - # +owner+:: [FXWindow] + # +store+:: {FXStream} + # +father+:: {FXWindow} + # +owner+:: {FXWindow} # def readWindow(store, father, owner); end diff --git a/rdoc-sources/FXArrowButton.rb b/rdoc-sources/FXArrowButton.rb index 478cee9..612aa1b 100755 --- a/rdoc-sources/FXArrowButton.rb +++ b/rdoc-sources/FXArrowButton.rb @@ -59,7 +59,7 @@ module Fox # Justification mode attr_accessor :justify - # Fill color for the arrow [FXColor] + # Fill color for the arrow {FXColor} attr_accessor :arrowColor # Construct arrow button diff --git a/rdoc-sources/FXBMPIcon.rb b/rdoc-sources/FXBMPIcon.rb index 603d68d..4ae22b9 100755 --- a/rdoc-sources/FXBMPIcon.rb +++ b/rdoc-sources/FXBMPIcon.rb @@ -23,9 +23,9 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in BMP file format [String] - # +clr+:: transparency color [FXColor] + # +clr+:: transparency color {FXColor} # +opts+:: options [Integer] # +width+:: width [Integer] # +height+:: height [Integer] @@ -42,7 +42,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data {FXStream} # def Fox.fxloadBMP(store); end @@ -52,9 +52,9 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the image data [FXStream] + # +store+:: stream to which to write the image data {FXStream} # +data+:: the image pixel data [String] - # +transp+:: transparency color [FXColor] + # +transp+:: transparency color {FXColor} # +width+:: width [Integer] # +height+:: height [Integer] # diff --git a/rdoc-sources/FXBMPImage.rb b/rdoc-sources/FXBMPImage.rb index 0422d6e..abfa889 100755 --- a/rdoc-sources/FXBMPImage.rb +++ b/rdoc-sources/FXBMPImage.rb @@ -18,7 +18,7 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in BMP file format [String] # +opts+:: options [Integer] # +width+:: width [Integer] diff --git a/rdoc-sources/FXBitmapFrame.rb b/rdoc-sources/FXBitmapFrame.rb index 8bb855e..0cb0d95 100755 --- a/rdoc-sources/FXBitmapFrame.rb +++ b/rdoc-sources/FXBitmapFrame.rb @@ -6,13 +6,13 @@ module Fox # class FXBitmapFrame < FXFrame - # The current image being displayed [FXBitmap] + # The current image being displayed {FXBitmap} attr_accessor :bitmap - # The color used for the "on" bits in the bitmap [FXColor] + # The color used for the "on" bits in the bitmap {FXColor} attr_accessor :onColor - # The color used for the "off" bits in the bitmap [FXColor] + # The color used for the "off" bits in the bitmap {FXColor} attr_accessor :offColor # diff --git a/rdoc-sources/FXBitmapView.rb b/rdoc-sources/FXBitmapView.rb index 80fb70e..327114c 100755 --- a/rdoc-sources/FXBitmapView.rb +++ b/rdoc-sources/FXBitmapView.rb @@ -22,13 +22,13 @@ module Fox # class FXBitmapView < FXScrollArea - # The bitmap [FXBitmap] + # The bitmap {FXBitmap} attr_accessor :bitmap - # The color used for the "on" bits in the bitmap [FXColor] + # The color used for the "on" bits in the bitmap {FXColor} attr_accessor :onColor - # The color used for the "off" bits in the bitmap [FXColor] + # The color used for the "off" bits in the bitmap {FXColor} attr_accessor :offColor # Current alignment [Integer] diff --git a/rdoc-sources/FXCheckButton.rb b/rdoc-sources/FXCheckButton.rb index 1b9c738..1d784fb 100755 --- a/rdoc-sources/FXCheckButton.rb +++ b/rdoc-sources/FXCheckButton.rb @@ -38,10 +38,10 @@ module Fox # Check button style [Integer] attr_accessor :checkButtonStyle - # Box background color [FXColor] + # Box background color {FXColor} attr_accessor :boxColor - # Box check color [FXColor] + # Box check color {FXColor} attr_accessor :checkColor # Construct new check button diff --git a/rdoc-sources/FXChoiceBox.rb b/rdoc-sources/FXChoiceBox.rb index f5b16fa..572546b 100644 --- a/rdoc-sources/FXChoiceBox.rb +++ b/rdoc-sources/FXChoiceBox.rb @@ -16,7 +16,7 @@ module Fox # +owner+:: Owner for this dialog box [FXWindow or FXApp] # +caption+:: Caption for this dialog box [String] # +text+:: Message text for this dialog box [String] - # +icon+:: Icon for this dialog box [FXIcon] + # +icon+:: Icon for this dialog box {FXIcon} # +choices+:: Array of strings containing choices [Array] # +opts+:: Dialog box options [Integer] # +x+:: x-coordinate @@ -39,7 +39,7 @@ module Fox # +opts+:: Dialog box options [Integer] # +caption+:: Caption for this dialog box [String] # +text+:: Message text for this dialog box [String] - # +icon+:: Icon for this dialog box [FXIcon] + # +icon+:: Icon for this dialog box {FXIcon} # +choices+:: Array of strings containing choices [Array] # def FXChoiceBox.ask(owner, opts, caption, text, icon, choices); end diff --git a/rdoc-sources/FXColorDialog.rb b/rdoc-sources/FXColorDialog.rb index a1dcfdb..684b4c1 100755 --- a/rdoc-sources/FXColorDialog.rb +++ b/rdoc-sources/FXColorDialog.rb @@ -21,7 +21,7 @@ module Fox class FXColorDialog < FXDialogBox - # The color [FXColor] + # The color {FXColor} attr_accessor :rgba # Only opaque colors allowed [Boolean] diff --git a/rdoc-sources/FXColorList.rb b/rdoc-sources/FXColorList.rb index 1942279..8aa7788 100644 --- a/rdoc-sources/FXColorList.rb +++ b/rdoc-sources/FXColorList.rb @@ -1,7 +1,7 @@ module Fox # Color item class FXColorItem < FXListItem - # Item color [FXColor] + # Item color {FXColor} attr_accessor :color # Return a new color item, initialized with the given text, color and diff --git a/rdoc-sources/FXColorSelector.rb b/rdoc-sources/FXColorSelector.rb index de7b3fc..ea11815 100755 --- a/rdoc-sources/FXColorSelector.rb +++ b/rdoc-sources/FXColorSelector.rb @@ -43,13 +43,13 @@ module Fox class FXColorSelector < FXPacker - # The "Accept" button [FXButton] + # The "Accept" button {FXButton} attr_reader :acceptButton - # The "Cancel" button [FXButton] + # The "Cancel" button {FXButton} attr_reader :cancelButton - # The color [FXColor] + # The color {FXColor} attr_accessor :rgba # Only opaque colors allowed [Boolean] diff --git a/rdoc-sources/FXColorWell.rb b/rdoc-sources/FXColorWell.rb index c422e94..27335a0 100755 --- a/rdoc-sources/FXColorWell.rb +++ b/rdoc-sources/FXColorWell.rb @@ -35,7 +35,7 @@ module Fox class FXColorWell < FXFrame - # The color [FXColor] + # The color {FXColor} attr_accessor :rgba # Status line help text [String] diff --git a/rdoc-sources/FXColorWheel.rb b/rdoc-sources/FXColorWheel.rb index 02270f1..f90878e 100755 --- a/rdoc-sources/FXColorWheel.rb +++ b/rdoc-sources/FXColorWheel.rb @@ -35,8 +35,8 @@ module Fox # # ==== Parameters: # - # +p+:: Parent widget [FXComposite] - # +target+:: Message target object [FXObject] + # +p+:: Parent widget {FXComposite} + # +target+:: Message target object {FXObject} # +selector+:: Message identifier [Integer] # +opts+:: Options [Integer] # +x+:: diff --git a/rdoc-sources/FXComboBox.rb b/rdoc-sources/FXComboBox.rb index 6c3fc1c..58b2d43 100755 --- a/rdoc-sources/FXComboBox.rb +++ b/rdoc-sources/FXComboBox.rb @@ -60,22 +60,22 @@ module Fox # Index of current item, or -1 if no current item [Integer] attr_accessor :currentItem - # Text font [FXFont] + # Text font {FXFont} attr_accessor :font # Combo box style [Integer] attr_accessor :comboStyle - # Window background color [FXColor] + # Window background color {FXColor} attr_accessor :backColor - # Text color [FXColor] + # Text color {FXColor} attr_accessor :textColor - # Background color for selected items [FXColor] + # Background color for selected items {FXColor} attr_accessor :selBackColor - # Text color for selected items [FXColor] + # Text color for selected items {FXColor} attr_accessor :selTextColor # Status line help text [String] @@ -89,9 +89,9 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this combo-box [FXComposite] + # +p+:: the parent widget for this combo-box {FXComposite} # +cols+:: number of columns [Integer] - # +target+:: message target [FXObject] + # +target+:: message target {FXObject} # +selector+:: message identifier [Integer] # +opts+:: the options [Integer] # +x+:: initial x-position [Integer] diff --git a/rdoc-sources/FXDC.rb b/rdoc-sources/FXDC.rb index 51fb10b..e7b5ddf 100755 --- a/rdoc-sources/FXDC.rb +++ b/rdoc-sources/FXDC.rb @@ -129,13 +129,13 @@ module Fox class FXDC - # Application [FXApp] + # Application {FXApp} attr_reader :app - # Foreground drawing color [FXColor] + # Foreground drawing color {FXColor} attr_accessor :foreground - # Background drawing color [FXColor] + # Background drawing color {FXColor} attr_accessor :background # Dash pattern [String] @@ -168,16 +168,16 @@ module Fox # Raster op function, one of +BLT_CLR+, +BLT_SRC+, +BLT_DST+, etc. (see list above) [Integer] attr_accessor :function - # Tile image [FXImage] + # Tile image {FXImage} attr_accessor :tile # Stipple pattern [FXBitmap or Integer] attr_accessor :stipple - # Clip region [FXRegion] + # Clip region {FXRegion} attr_writer :clipRegion - # Clip rectangle [FXRectangle] + # Clip rectangle {FXRectangle} attr_reader :clipRectangle # X-coordinate of clip rectangle [Integer] @@ -192,7 +192,7 @@ module Fox # Height of clip rectangle, in pixels [Integer] attr_reader :clipHeight - # Font to draw text with [FXFont] + # Font to draw text with {FXFont} attr_accessor :font # Construct dummy DC @@ -530,7 +530,7 @@ module Fox # # === Parameters: # - # +source+:: the source drawable from which to copy [FXDrawable] + # +source+:: the source drawable from which to copy {FXDrawable} # +sx+:: x-coordinate of the upper left corner of the source rectangle [Integer] # +sy+:: y-coordinate of the upper left corner of the source rectangle [Integer] # +sw+:: width of the source rectangle, in pixels [Integer] @@ -546,7 +546,7 @@ module Fox # # === Parameters: # - # +source+:: the source drawable from which to copy [FXDrawable] + # +source+:: the source drawable from which to copy {FXDrawable} # +sx+:: x-coordinate of the upper left corner of the source rectangle [Integer] # +sy+:: y-coordinate of the upper left corner of the source rectangle [Integer] # +sw+:: width of the source rectangle, in pixels [Integer] @@ -563,7 +563,7 @@ module Fox # # === Parameters: # - # +image+:: image to draw [FXImage] + # +image+:: image to draw {FXImage} # +dx+:: x-coordinate of the the destination point in this drawable [Integer] # +dy+:: y-coordinate of the the destination point in this drawable [Integer] # @@ -574,7 +574,7 @@ module Fox # # === Parameters: # - # +bitmap+:: bitmap to draw [FXBitmap] + # +bitmap+:: bitmap to draw {FXBitmap} # +dx+:: x-coordinate of the the destination point in this drawable [Integer] # +dy+:: y-coordinate of the the destination point in this drawable [Integer] # @@ -585,7 +585,7 @@ module Fox # # === Parameters: # - # +icon+:: icon to draw [FXIcon] + # +icon+:: icon to draw {FXIcon} # +dx+:: x-coordinate of the the destination point in this drawable [Integer] # +dy+:: y-coordinate of the the destination point in this drawable [Integer] # @@ -597,7 +597,7 @@ module Fox # # === Parameters: # - # +icon+:: icon to draw [FXIcon] + # +icon+:: icon to draw {FXIcon} # +dx+:: x-coordinate of the the destination point in this drawable [Integer] # +dy+:: y-coordinate of the the destination point in this drawable [Integer] # @@ -608,7 +608,7 @@ module Fox # # === Parameters: # - # +icon+:: icon to draw [FXIcon] + # +icon+:: icon to draw {FXIcon} # +dx+:: x-coordinate of the the destination point in this drawable [Integer] # +dy+:: y-coordinate of the the destination point in this drawable [Integer] # @@ -689,7 +689,7 @@ module Fox # # === Parameters: # - # +bitmap+:: a bitmap to use for clipping [FXBitmap] + # +bitmap+:: a bitmap to use for clipping {FXBitmap} # +dx+:: [Integer] # +dy+:: [Integer] # diff --git a/rdoc-sources/FXDataTarget.rb b/rdoc-sources/FXDataTarget.rb index 77cc605..c9cd25b 100755 --- a/rdoc-sources/FXDataTarget.rb +++ b/rdoc-sources/FXDataTarget.rb @@ -44,7 +44,7 @@ module Fox # class FXDataTarget < FXObject - # The message target object for this data target [FXObject] + # The message target object for this data target {FXObject} attr_accessor :target # The message identifier for this data target [Integer] diff --git a/rdoc-sources/FXDelegator.rb b/rdoc-sources/FXDelegator.rb index bfca5de..d14e34f 100755 --- a/rdoc-sources/FXDelegator.rb +++ b/rdoc-sources/FXDelegator.rb @@ -10,7 +10,7 @@ module Fox # class FXDelegator < FXObject - # The object to which all messages are delegated [FXObject] + # The object to which all messages are delegated {FXObject} attr_accessor :delegate # diff --git a/rdoc-sources/FXDial.rb b/rdoc-sources/FXDial.rb index 1b03261..d7e9de0 100755 --- a/rdoc-sources/FXDial.rb +++ b/rdoc-sources/FXDial.rb @@ -60,7 +60,7 @@ module Fox # Current dial style [Integer] attr_accessor :dialStyle - # Center notch color [FXColor] + # Center notch color {FXColor} attr_accessor :notchColor # Status line help text for this dial [String] @@ -74,8 +74,8 @@ module Fox # # ==== Parameters: # - # +p+:: parent widget for this dial [FXComposite] - # +target+:: message target object for this dial [FXObject] + # +p+:: parent widget for this dial {FXComposite} + # +target+:: message target object for this dial {FXObject} # +selector+:: message identifier [Integer] # +opts+:: # +x+:: diff --git a/rdoc-sources/FXDirBox.rb b/rdoc-sources/FXDirBox.rb index 6fdb94d..1601393 100755 --- a/rdoc-sources/FXDirBox.rb +++ b/rdoc-sources/FXDirBox.rb @@ -24,7 +24,7 @@ module Fox # Current directory [String] attr_accessor :directory - # File associations [FXFileDict] + # File associations {FXFileDict} attr_accessor :associations # Return an initialized FXDirBox instance. diff --git a/rdoc-sources/FXDirList.rb b/rdoc-sources/FXDirList.rb index b2aeeeb..b2a50bc 100755 --- a/rdoc-sources/FXDirList.rb +++ b/rdoc-sources/FXDirList.rb @@ -3,7 +3,7 @@ module Fox # Directory item # class FXDirItem < FXTreeItem - # File associations [FXFileAssoc] + # File associations {FXFileAssoc} attr_reader :assoc # File size [Integer] @@ -86,7 +86,7 @@ module Fox # Wildcard matching mode, some combination of file matching flags [Integer] attr_accessor :matchMode - # File associations [FXFileDict] + # File associations {FXFileDict} attr_accessor :associations # Returns an initialized FXDirList instance diff --git a/rdoc-sources/FXDirSelector.rb b/rdoc-sources/FXDirSelector.rb index 1461696..1f196c3 100755 --- a/rdoc-sources/FXDirSelector.rb +++ b/rdoc-sources/FXDirSelector.rb @@ -23,10 +23,10 @@ module Fox # class FXDirSelector < FXPacker - # The "Accept" button [FXButton] + # The "Accept" button {FXButton} attr_reader :acceptButton - # The "Cancel" button [FXButton] + # The "Cancel" button {FXButton} attr_reader :cancelButton # Directory [String] diff --git a/rdoc-sources/FXDockBar.rb b/rdoc-sources/FXDockBar.rb index 5e4d34f..083c902 100755 --- a/rdoc-sources/FXDockBar.rb +++ b/rdoc-sources/FXDockBar.rb @@ -41,8 +41,8 @@ module Fox # # ==== Parameters: # - # +p+:: the "dry dock" window for this dock bar [FXComposite] - # +q+:: the "wet dock" window for this dock bar [FXComposite] + # +p+:: the "dry dock" window for this dock bar {FXComposite} + # +q+:: the "wet dock" window for this dock bar {FXComposite} # +opts+:: dock bar options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] @@ -64,7 +64,7 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this dock bar [FXComposite] + # +p+:: the parent window for this dock bar {FXComposite} # +opts+:: dock bar options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] diff --git a/rdoc-sources/FXDockSite.rb b/rdoc-sources/FXDockSite.rb index f6c306e..083082e 100644 --- a/rdoc-sources/FXDockSite.rb +++ b/rdoc-sources/FXDockSite.rb @@ -42,7 +42,7 @@ module Fox # # ==== Parameters: # - # +bar+:: a reference to the dockbar that's being dragged [FXDockBar] + # +bar+:: a reference to the dockbar that's being dragged {FXDockBar} # +barx+:: current x-coordinate of the dockbar [Integer] # +bary+ current y-coordinate of the dockbar [Integer] # @@ -56,8 +56,8 @@ module Fox # # ==== Parameters: # - # +bar+:: a reference to the newly docked dockbar [FXDockBar] - # +before+:: a reference to the window that the dockbar was added before [FXWindow] + # +bar+:: a reference to the newly docked dockbar {FXDockBar} + # +before+:: a reference to the window that the dockbar was added before {FXWindow} # def dockToolBar(bar, before); end @@ -69,7 +69,7 @@ module Fox # # ==== Parameters: # - # +bar+:: a reference to the newly docked dockbar [FXDockBar][FXDockBar] + # +bar+:: a reference to the newly docked dockbar {FXDockBar}{FXDockBar} # +barx+:: x-coordinate of the docking position [Integer] # +bary+:: y-coordinate of the docking position [Integer] # @@ -83,7 +83,7 @@ module Fox # # ==== Parameters: # - # +bar+:: a reference to the removed dockbar [FXDockBar] + # +bar+:: a reference to the removed dockbar {FXDockBar} # def undockToolBar(bar); end diff --git a/rdoc-sources/FXDockTitle.rb b/rdoc-sources/FXDockTitle.rb index 2c43aa0..e69a7f8 100755 --- a/rdoc-sources/FXDockTitle.rb +++ b/rdoc-sources/FXDockTitle.rb @@ -8,10 +8,10 @@ module Fox # Caption text for the grip [String] attr_accessor :caption - # Caption font [FXFont] + # Caption font {FXFont} attr_accessor :font - # Caption color [FXColor] + # Caption color {FXColor} attr_accessor :captionColor # Current justification mode [Integer] diff --git a/rdoc-sources/FXDragCorner.rb b/rdoc-sources/FXDragCorner.rb index f58a273..a32cc9d 100755 --- a/rdoc-sources/FXDragCorner.rb +++ b/rdoc-sources/FXDragCorner.rb @@ -5,10 +5,10 @@ module Fox # class FXDragCorner < FXWindow - # Highlight color [FXColor] + # Highlight color {FXColor} attr_accessor :hiliteColor - # Shadow color [FXColor] + # Shadow color {FXColor} attr_accessor :shadowColor # Construct a drag corner diff --git a/rdoc-sources/FXDrawable.rb b/rdoc-sources/FXDrawable.rb index e322f9d..a07ab57 100755 --- a/rdoc-sources/FXDrawable.rb +++ b/rdoc-sources/FXDrawable.rb @@ -11,7 +11,7 @@ module Fox # Height of drawable, in pixels [Integer] attr_reader :height - # Visual [FXVisual] + # Visual {FXVisual} attr_accessor :visual # diff --git a/rdoc-sources/FXDriveBox.rb b/rdoc-sources/FXDriveBox.rb index 78e173f..86abb3a 100755 --- a/rdoc-sources/FXDriveBox.rb +++ b/rdoc-sources/FXDriveBox.rb @@ -14,7 +14,7 @@ module Fox # Current drive [String] attr_accessor :drive - # File associations [FXFileDict] + # File associations {FXFileDict} attr_accessor :associations # Returns an initialized FXDriveBox instance diff --git a/rdoc-sources/FXFileDialog.rb b/rdoc-sources/FXFileDialog.rb index 8305856..a79a16d 100755 --- a/rdoc-sources/FXFileDialog.rb +++ b/rdoc-sources/FXFileDialog.rb @@ -163,7 +163,7 @@ module Fox # # ==== Parameters: # - # +owner+:: the owner window for the dialog box [FXWindow] + # +owner+:: the owner window for the dialog box {FXWindow} # +caption+:: the caption for the dialog box [String] # +path+:: the initial filename [String] # +patterns+:: the pattern list [String] @@ -178,7 +178,7 @@ module Fox # # ==== Parameters: # - # +owner+:: the owner window for the dialog box [FXWindow] + # +owner+:: the owner window for the dialog box {FXWindow} # +caption+:: the caption for the dialog box [String] # +path+:: the initial filename [String] # +patterns+:: the pattern list [String] @@ -193,7 +193,7 @@ module Fox # # ==== Parameters: # - # +owner+:: the owner window for the dialog box [FXWindow] + # +owner+:: the owner window for the dialog box {FXWindow} # +caption+:: the caption for the dialog box [String] # +path+:: the initial filename [String] # +patterns+:: the pattern list [String] @@ -207,7 +207,7 @@ module Fox # # ==== Parameters: # - # +owner+:: the owner window for the dialog box [FXWindow] + # +owner+:: the owner window for the dialog box {FXWindow} # +caption+:: the caption for the dialog box [String] # +path+:: the initial directory path [String] # diff --git a/rdoc-sources/FXFileDict.rb b/rdoc-sources/FXFileDict.rb index 2f5edc0..bcaa41c 100755 --- a/rdoc-sources/FXFileDict.rb +++ b/rdoc-sources/FXFileDict.rb @@ -12,19 +12,19 @@ module Fox # Mime type name [String] attr_accessor :mimetype - # Big normal icon [FXIcon] + # Big normal icon {FXIcon} attr_accessor :bigicon - # Big open icon [FXIcon] + # Big open icon {FXIcon} attr_accessor :bigiconopen - # Mini normal icon [FXIcon] + # Mini normal icon {FXIcon} attr_accessor :miniicon - # Mini open icon [FXIcon] + # Mini open icon {FXIcon} attr_accessor :miniiconopen - # Registered drag type [FXDragType] + # Registered drag type {FXDragType} attr_accessor :dragtype # Flags [Integer] @@ -65,10 +65,10 @@ module Fox # class FXFileDict < FXDict - # Settings database [FXSettings] + # Settings database {FXSettings} attr_accessor :settings - # Current icon search path [FXIconDict] + # Current icon search path {FXIconDict} attr_accessor :iconDict # Current icon search path [String] @@ -91,8 +91,8 @@ module Fox # # ==== Parameters: # - # +app+: Application [FXApp] - # +db+:: Settings database [FXSettings] + # +app+: Application {FXApp} + # +db+:: Settings database {FXSettings} # def initialize(app, db=nil); end diff --git a/rdoc-sources/FXFileList.rb b/rdoc-sources/FXFileList.rb index d38a498..127311b 100755 --- a/rdoc-sources/FXFileList.rb +++ b/rdoc-sources/FXFileList.rb @@ -4,7 +4,7 @@ module Fox # class FXFileItem < FXIconItem - # The file association object for this item [FXFileAssoc] + # The file association object for this item {FXFileAssoc} attr_reader :assoc # The file size for this item [Integer] @@ -98,7 +98,7 @@ module Fox # Wildcard matching mode [Integer] attr_accessor :matchMode - # File associations [FXFileDict] + # File associations {FXFileDict} attr_accessor :associations # Image size for preview images [Integer] diff --git a/rdoc-sources/FXFileSelector.rb b/rdoc-sources/FXFileSelector.rb index f792578..8d9b381 100755 --- a/rdoc-sources/FXFileSelector.rb +++ b/rdoc-sources/FXFileSelector.rb @@ -43,10 +43,10 @@ module Fox # class FXFileSelector < FXPacker - # The "Accept" button [FXButton] + # The "Accept" button {FXButton} attr_reader :acceptButton - # The "Cancel" button [FXButton] + # The "Cancel" button {FXButton} attr_reader :cancelButton # File name [String] diff --git a/rdoc-sources/FXFoldingList.rb b/rdoc-sources/FXFoldingList.rb index ca28456..3dc04ad 100755 --- a/rdoc-sources/FXFoldingList.rb +++ b/rdoc-sources/FXFoldingList.rb @@ -4,25 +4,25 @@ module Fox # class FXFoldingItem < FXObject - # Parent item [FXFoldingItem] + # Parent item {FXFoldingItem} attr_reader :parent - # Next sibling item [FXFoldingItem] + # Next sibling item {FXFoldingItem} attr_reader :next - # Previous sibling item [FXFoldingItem] + # Previous sibling item {FXFoldingItem} attr_reader :prev - # First child item [FXFoldingItem] + # First child item {FXFoldingItem} attr_reader :first - # Last child item [FXFoldingItem] + # Last child item {FXFoldingItem} attr_reader :last - # Item logically below this item [FXFoldingItem] + # Item logically below this item {FXFoldingItem} attr_reader :below - # Item logically above this item [FXFoldingItem] + # Item logically above this item {FXFoldingItem} attr_reader :above # Number of child items [Integer] @@ -31,10 +31,10 @@ module Fox # Item text [String] attr_accessor :text - # Open icon [FXIcon] + # Open icon {FXIcon} attr_accessor :openIcon - # Closed icon [FXIcon] + # Closed icon {FXIcon} attr_accessor :closedIcon # User data [Object] @@ -188,7 +188,7 @@ module Fox class FXFoldingList < FXScrollArea - # Header control [FXHeader] + # Header control {FXHeader} attr_reader :header # Number of header items [Integer] @@ -200,37 +200,37 @@ module Fox # Number of visible items [Integer] attr_accessor :numVisible - # First root-level item [FXFoldingItem] + # First root-level item {FXFoldingItem} attr_reader :firstItem - # Last root-level item [FXFoldingItem] + # Last root-level item {FXFoldingItem} attr_reader :lastItem - # Current item, if any [FXFoldingItem] + # Current item, if any {FXFoldingItem} attr_accessor :currentItem - # Anchor item, if any [FXFoldingItem] + # Anchor item, if any {FXFoldingItem} attr_accessor :anchorItem - # Item under the cursor, if any [FXFoldingItem] + # Item under the cursor, if any {FXFoldingItem} attr_reader :cursorItem - # Text font [FXFont] + # Text font {FXFont} attr_accessor :font # Parent-child indent amount, in pixels [Integer] attr_accessor :indent - # Normal text color [FXColor] + # Normal text color {FXColor} attr_accessor :textColor - # Selected text background color [FXColor] + # Selected text background color {FXColor} attr_accessor :selBackColor - # Selected text color [FXColor] + # Selected text color {FXColor} attr_accessor :selTextColor - # Line color [FXColor] + # Line color {FXColor} attr_accessor :lineColor # List style [Integer] @@ -244,8 +244,8 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this folding list [FXComposite] - # +target+:: the message target, if any, for this folding list [FXObject] + # +p+:: the parent window for this folding list {FXComposite} + # +target+:: the message target, if any, for this folding list {FXObject} # +selector+:: the message identifier for this folding list [Integer] # +opts+:: folding list options [Integer] # +x+:: initial x-position [Integer] diff --git a/rdoc-sources/FXFont.rb b/rdoc-sources/FXFont.rb index 18eab47..bb95bb5 100755 --- a/rdoc-sources/FXFont.rb +++ b/rdoc-sources/FXFont.rb @@ -214,7 +214,7 @@ module Fox # Hints [Integer] attr_reader :hints - # Font description [FXFontDesc] + # Font description {FXFontDesc} attr_accessor :fontDesc # Font angle [Integer] @@ -252,8 +252,8 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +fontDesc+:: a font description [FXFontDesc] + # +a+:: an application instance {FXApp} + # +fontDesc+:: a font description {FXFontDesc} # def initialize(a, fontDesc) # :yields: theFont end @@ -266,7 +266,7 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +face+:: font face name [String] # +size+:: requested font size, in points [Integer] # +weight+:: requested font weight [Integer] diff --git a/rdoc-sources/FXFontDialog.rb b/rdoc-sources/FXFontDialog.rb index 8e4f37a..e7fe91e 100755 --- a/rdoc-sources/FXFontDialog.rb +++ b/rdoc-sources/FXFontDialog.rb @@ -4,7 +4,7 @@ module Fox # class FXFontDialog < FXDialogBox - # Current font selection [FXFontDesc] + # Current font selection {FXFontDesc} attr_accessor :fontSelection # Return an initialized FXFontDialog instance. diff --git a/rdoc-sources/FXFontSelector.rb b/rdoc-sources/FXFontSelector.rb index 713c2a2..c80c677 100755 --- a/rdoc-sources/FXFontSelector.rb +++ b/rdoc-sources/FXFontSelector.rb @@ -18,13 +18,13 @@ module Fox # class FXFontSelector < FXPacker - # The "Accept" button [FXButton] + # The "Accept" button {FXButton} attr_reader :acceptButton - # The "Cancel" button [FXButton] + # The "Cancel" button {FXButton} attr_reader :cancelButton - # Font selection [FXFontDesc] + # Font selection {FXFontDesc} attr_accessor :fontSelection # diff --git a/rdoc-sources/FXFrame.rb b/rdoc-sources/FXFrame.rb index 3304d94..f854f95 100755 --- a/rdoc-sources/FXFrame.rb +++ b/rdoc-sources/FXFrame.rb @@ -32,16 +32,16 @@ module Fox # Right interior padding, in pixels [Integer] attr_accessor :padRight - # Highlight color [FXColor] + # Highlight color {FXColor} attr_accessor :hiliteColor - # Shadow color [FXColor] + # Shadow color {FXColor} attr_accessor :shadowColor - # Border color [FXColor] + # Border color {FXColor} attr_accessor :borderColor - # Base GUI color [FXColor] + # Base GUI color {FXColor} attr_accessor :baseColor # diff --git a/rdoc-sources/FXGIFCursor.rb b/rdoc-sources/FXGIFCursor.rb index 5811248..7ada095 100755 --- a/rdoc-sources/FXGIFCursor.rb +++ b/rdoc-sources/FXGIFCursor.rb @@ -23,7 +23,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the image data [FXStream] + # +store+:: stream to which to write the image data {FXStream} # +data+:: the image pixel data [Array of FXColor] # +width+:: width [Integer] # +height+:: height [Integer] @@ -39,7 +39,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data {FXStream} # def Fox.fxloadGIF(store); end diff --git a/rdoc-sources/FXGIFIcon.rb b/rdoc-sources/FXGIFIcon.rb index dab8910..cb780b2 100755 --- a/rdoc-sources/FXGIFIcon.rb +++ b/rdoc-sources/FXGIFIcon.rb @@ -18,9 +18,9 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in GIF file format [String] - # +clr+:: transparency color [FXColor] + # +clr+:: transparency color {FXColor} # +opts+:: options [Integer] # +width+:: width [Integer] # +height+:: height [Integer] diff --git a/rdoc-sources/FXGIFImage.rb b/rdoc-sources/FXGIFImage.rb index bfe1954..5beb4d1 100755 --- a/rdoc-sources/FXGIFImage.rb +++ b/rdoc-sources/FXGIFImage.rb @@ -16,7 +16,7 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in GIF file format [String] # +opts+:: options [Integer] # +width+:: width [Integer] diff --git a/rdoc-sources/FXGLContext.rb b/rdoc-sources/FXGLContext.rb index a7882ba..6d15d90 100755 --- a/rdoc-sources/FXGLContext.rb +++ b/rdoc-sources/FXGLContext.rb @@ -11,7 +11,7 @@ module Fox # class FXGLContext < FXId - # The visual [FXGLVisual] + # The visual {FXGLVisual} attr_reader :visual # Construct an OpenGL context. diff --git a/rdoc-sources/FXGLObject.rb b/rdoc-sources/FXGLObject.rb index e056274..d3e7d75 100755 --- a/rdoc-sources/FXGLObject.rb +++ b/rdoc-sources/FXGLObject.rb @@ -24,7 +24,7 @@ module Fox # # ==== Parameters: # - # +viewer+:: the viewer window into which we're drawing [FXGLViewer] + # +viewer+:: the viewer window into which we're drawing {FXGLViewer} # def draw(viewer); end @@ -33,7 +33,7 @@ module Fox # # ==== Parameters: # - # +viewer+:: the viewer window into which we're drawing [FXGLViewer] + # +viewer+:: the viewer window into which we're drawing {FXGLViewer} # def hit(viewer); end @@ -53,7 +53,7 @@ module Fox # # ==== Parameters: # - # +viewer+:: the viewer window in which we're dragging [FXGLViewer] + # +viewer+:: the viewer window in which we're dragging {FXGLViewer} # +fx+:: x-coordinate for position we're dragging from [Integer] # +fy+:: y-coordinate for position we're dragging from [Integer] # +tx+:: x-coordinate for position we're dragging to [Integer] diff --git a/rdoc-sources/FXGLShape.rb b/rdoc-sources/FXGLShape.rb index e9ac67b..4d43ed3 100755 --- a/rdoc-sources/FXGLShape.rb +++ b/rdoc-sources/FXGLShape.rb @@ -35,7 +35,7 @@ module Fox # Tool tip message for this shape [String] attr_accessor :tipText - # Position [FXVec3f] + # Position {FXVec3f} attr_accessor :position # diff --git a/rdoc-sources/FXGLViewer.rb b/rdoc-sources/FXGLViewer.rb index 7850656..c70138e 100755 --- a/rdoc-sources/FXGLViewer.rb +++ b/rdoc-sources/FXGLViewer.rb @@ -31,19 +31,19 @@ module Fox # OpenGL Light Source class FXLight - # Ambient light color [FXVec4f] + # Ambient light color {FXVec4f} attr_accessor :ambient - # Diffuse light color [FXVec4f] + # Diffuse light color {FXVec4f} attr_accessor :diffuse - # Specular light color [FXVec4f] + # Specular light color {FXVec4f} attr_accessor :specular - # Light position [FXVec4f] + # Light position {FXVec4f} attr_accessor :position - # Spot direction [FXVec3f] + # Spot direction {FXVec3f} attr_accessor :direction # Spotlight exponent [Float] @@ -67,16 +67,16 @@ module Fox # OpenGL Material Description class FXMaterial - # Ambient material color [FXVec4f] + # Ambient material color {FXVec4f} attr_accessor :ambient - # Diffuse material color [FXVec4f] + # Diffuse material color {FXVec4f} attr_accessor :diffuse - # Specular material color [FXVec4f] + # Specular material color {FXVec4f} attr_accessor :specular - # Emissive material color [FXVec4f] + # Emissive material color {FXVec4f} attr_accessor :emission # Specular shininess [Float] @@ -179,10 +179,10 @@ module Fox # Size of pixel in model coordinates [Float] attr_reader :modelPix - # The viewport for this viewer [FXViewport] + # The viewport for this viewer {FXViewport} attr_reader :viewport - # Default object material setting [FXMaterial] + # Default object material setting {FXMaterial} attr_accessor :material # Camera field of view angle (in degrees) [Float] @@ -194,19 +194,19 @@ module Fox # Target point distance [Float] attr_accessor :distance - # Current scaling factors [FXVec3f] + # Current scaling factors {FXVec3f} attr_accessor :scale - # Camera orientation [FXQuatf] + # Camera orientation {FXQuatf} attr_accessor :orientation - # Object center [FXVec3f] + # Object center {FXVec3f} attr_accessor :center - # Eyesight vector [FXVec3f] + # Eyesight vector {FXVec3f} attr_reader :eyeVector - # Eye position [FXVec3f] + # Eye position {FXVec3f} attr_reader :eyePosition # Status line help text [String] @@ -215,22 +215,22 @@ module Fox # Tool tip text [String] attr_accessor :tipText - # The current transformation matrix [FXMat4f] + # The current transformation matrix {FXMat4f} attr_reader :transform - # The inverse of the current transformation matrix [FXMat4f] + # The inverse of the current transformation matrix {FXMat4f} attr_reader :invTransform - # The current scene object [FXGLObject] + # The current scene object {FXGLObject} attr_accessor :scene - # The selection [FXGLObject] + # The selection {FXGLObject} attr_accessor :selection # The projection mode (either +FXGLViewer::PERSPECTIVE+ or +FXGLViewer::PARALLEL+) attr_accessor :projection - # Global ambient light color [FXMat4f] + # Global ambient light color {FXMat4f} attr_accessor :ambientColor # The maximum hits, i.e. the maximum size of the pick buffer [Integer]. @@ -240,7 +240,7 @@ module Fox # Set turbo mode [Boolean] attr_writer :turboMode - # Light source settings [FXLight] + # Light source settings {FXLight} attr_accessor :light # Returns the FXDragType for FXGLObject diff --git a/rdoc-sources/FXGradientBar.rb b/rdoc-sources/FXGradientBar.rb index 4556f50..490d778 100755 --- a/rdoc-sources/FXGradientBar.rb +++ b/rdoc-sources/FXGradientBar.rb @@ -16,10 +16,10 @@ module Fox # Upper value [Float] attr_accessor :upper - # Lower color [FXColor] + # Lower color {FXColor} attr_accessor :lowerColor - # Upper color [FXColor] + # Upper color {FXColor} attr_accessor :upperColor # Blend mode [Integer] @@ -82,7 +82,7 @@ module Fox # attr_accessor :barStyle - # Selection color [FXColor] + # Selection color {FXColor} attr_accessor :selectColor # Status line help text [String] diff --git a/rdoc-sources/FXGroupBox.rb b/rdoc-sources/FXGroupBox.rb index 83718cf..106808a 100755 --- a/rdoc-sources/FXGroupBox.rb +++ b/rdoc-sources/FXGroupBox.rb @@ -19,10 +19,10 @@ module Fox # Group box style [Integer] attr_accessor :groupBoxStyle - # Title font [FXFont] + # Title font {FXFont} attr_accessor :font - # Title text color [FXColor] + # Title text color {FXColor} attr_accessor :textColor # Construct group box layout manager diff --git a/rdoc-sources/FXHeader.rb b/rdoc-sources/FXHeader.rb index f4c517b..22c52df 100755 --- a/rdoc-sources/FXHeader.rb +++ b/rdoc-sources/FXHeader.rb @@ -30,7 +30,7 @@ module Fox # Item's text label [String] attr_accessor :text - # Item's icon [FXIcon] + # Item's icon {FXIcon} attr_accessor :icon # Item's user data [Object] @@ -146,10 +146,10 @@ module Fox # Current position [Integer] attr_accessor :position - # Text font [FXFont] + # Text font {FXFont} attr_accessor :font - # Text color [FXColor] + # Text color {FXColor} attr_accessor :textColor # Header style options [Integer] diff --git a/rdoc-sources/FXHorizontalFrame.rb b/rdoc-sources/FXHorizontalFrame.rb index da2ed22..4e79381 100755 --- a/rdoc-sources/FXHorizontalFrame.rb +++ b/rdoc-sources/FXHorizontalFrame.rb @@ -10,7 +10,7 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this horizontal frame [FXComposite] + # +p+:: the parent window for this horizontal frame {FXComposite} # +opts+:: frame options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] diff --git a/rdoc-sources/FXICOIcon.rb b/rdoc-sources/FXICOIcon.rb index aa35c04..c22970f 100755 --- a/rdoc-sources/FXICOIcon.rb +++ b/rdoc-sources/FXICOIcon.rb @@ -18,9 +18,9 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in ICO file format [String] - # +clr+:: transparency color [FXColor] + # +clr+:: transparency color {FXColor} # +opts+:: options [Integer] # +width+:: width [Integer] # +height+:: height [Integer] @@ -37,7 +37,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data {FXStream} # def Fox.fxloadICO(store); end @@ -47,9 +47,9 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the image data [FXStream] + # +store+:: stream to which to write the image data {FXStream} # +pixels+:: the image pixel data [String] - # +transp+:: transparency color [FXColor] + # +transp+:: transparency color {FXColor} # +width+:: width [Integer] # +height+:: height [Integer] # +xspot+:: hotspot x-coordinate [Integer] diff --git a/rdoc-sources/FXICOImage.rb b/rdoc-sources/FXICOImage.rb index 099f78b..8792804 100755 --- a/rdoc-sources/FXICOImage.rb +++ b/rdoc-sources/FXICOImage.rb @@ -18,7 +18,7 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in ICO file format [String] # +opts+:: options [Integer] # +width+:: width [Integer] diff --git a/rdoc-sources/FXIcon.rb b/rdoc-sources/FXIcon.rb index 6d64f61..1e7b48a 100755 --- a/rdoc-sources/FXIcon.rb +++ b/rdoc-sources/FXIcon.rb @@ -7,7 +7,7 @@ module Fox # class FXIcon < FXImage - # Transparency color [FXColor] + # Transparency color {FXColor} attr_accessor :transparentColor # @@ -25,9 +25,9 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: initial pixel buffer [String] - # +clr+:: transparency color [FXColor] + # +clr+:: transparency color {FXColor} # +opts+:: options [Integer] # +width+:: width [Integer] # +height+:: height [Integer] diff --git a/rdoc-sources/FXIconList.rb b/rdoc-sources/FXIconList.rb index c424df9..e113233 100755 --- a/rdoc-sources/FXIconList.rb +++ b/rdoc-sources/FXIconList.rb @@ -7,10 +7,10 @@ module Fox # Item text [String] attr_accessor :text - # Big icon [FXIcon] + # Big icon {FXIcon} attr_accessor :bigIcon - # Mini icon [FXIcon] + # Mini icon {FXIcon} attr_accessor :miniIcon # Item user data [Object] @@ -143,7 +143,7 @@ module Fox # Number of columns [Integer] attr_reader :numCols - # The header control [FXHeader] + # The header control {FXHeader} attr_reader :header # The number of header items in the header control [Integer] @@ -164,16 +164,16 @@ module Fox # Index of item under the cursor, or -1 if none [Integer] attr_reader :cursorItem - # Text font [FXFont] + # Text font {FXFont} attr_accessor :font - # Normal text color [FXColor] + # Normal text color {FXColor} attr_accessor :textColor - # Background color for selected item(s) [FXColor] + # Background color for selected item(s) {FXColor} attr_accessor :selBackColor - # Text color for selected item(s) [FXColor] + # Text color for selected item(s) {FXColor} attr_accessor :selTextColor # Maximum item space (in pixels) for each item [Integer] diff --git a/rdoc-sources/FXId.rb b/rdoc-sources/FXId.rb index 859a85d..664c4f9 100755 --- a/rdoc-sources/FXId.rb +++ b/rdoc-sources/FXId.rb @@ -4,7 +4,7 @@ module Fox # class FXId < FXObject - # Application [FXApp] + # Application {FXApp} attr_reader :app # User data [Object] diff --git a/rdoc-sources/FXImage.rb b/rdoc-sources/FXImage.rb index 24d95bd..d539128 100755 --- a/rdoc-sources/FXImage.rb +++ b/rdoc-sources/FXImage.rb @@ -39,7 +39,7 @@ module Fox class FXImage < FXDrawable - # [deprecated] Pixel data [FXMemoryBuffer] + # [deprecated] Pixel data {FXMemoryBuffer} attr_reader :data # Array of colors of all image pixels. Can also be written as String of raw [RGBA] values. @@ -60,7 +60,7 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pixels+:: pixels [Array of FXColor values or string of raw [RGBA] values] # +opts+:: image options [Integer] # +width+:: image width [Integer] @@ -111,7 +111,7 @@ module Fox # # +x+:: x-coordinate of the pixel of interest [Integer] # +y+:: y-coordinate of the pixel of interest [Integer] - # +clr+:: new color value for this pixel [FXColor] + # +clr+:: new color value for this pixel {FXColor} # def setPixel(x, y, clr) ; end @@ -195,7 +195,7 @@ module Fox # +y+:: y-coordinate for top left corner of the clip rectangle [Integer] # +width+:: width of the clip rectangle [Integer] # +height+:: height of the clip rectangle [Integer] - # +color+:: fill color for blank areas after crop [FXColor] + # +color+:: fill color for blank areas after crop {FXColor} # def crop(x, y, w, h, color=0) ; end @@ -209,7 +209,7 @@ module Fox # # ==== Parameters: # - # +color+:: the fade color [FXColor] + # +color+:: the fade color {FXColor} # +factor+:: fading factor [Integer] # def fade(color, factor=255); end @@ -223,7 +223,7 @@ module Fox # ==== Parameters: # # +shear+:: how far to shear [Integer] - # +color+:: fill color for areas outside the sheared image [FXColor] + # +color+:: fill color for areas outside the sheared image {FXColor} # def xshear(shear, color=0); end @@ -236,7 +236,7 @@ module Fox # ==== Parameters: # # +shear+:: how far to shear [Integer] - # +color+:: fill color for areas outside the sheared image [FXColor] + # +color+:: fill color for areas outside the sheared image {FXColor} # def yshear(shear, color=0); end @@ -245,8 +245,8 @@ module Fox # # ==== Parameters: # - # +left+:: starting color, for leftmost pixels [FXColor] - # +right+:: ending color, for rightmost pixels [FXColor] + # +left+:: starting color, for leftmost pixels {FXColor} + # +right+:: ending color, for rightmost pixels {FXColor} # def hgradient(left, right); end @@ -255,8 +255,8 @@ module Fox # # ==== Parameters: # - # +top+:: starting color, for topmost pixels [FXColor] - # +bottom+:: ending color, for bottommost pixels [FXColor] + # +top+:: starting color, for topmost pixels {FXColor} + # +bottom+:: ending color, for bottommost pixels {FXColor} # def vgradient(top, bottom); end @@ -265,10 +265,10 @@ module Fox # # ==== Parameters: # - # +topleft+:: pixel color for top-left corner [FXColor] - # +topright+:: pixel color for top-right corner [FXColor] - # +bottomleft+:: pixel color for bottom-left corner [FXColor] - # +bottomright+:: pixel color for bottom-right corner [FXColor] + # +topleft+:: pixel color for top-left corner {FXColor} + # +topright+:: pixel color for top-right corner {FXColor} + # +bottomleft+:: pixel color for bottom-left corner {FXColor} + # +bottomright+:: pixel color for bottom-right corner {FXColor} # def gradient(topleft, topright, bottomleft, bottomright); end @@ -277,7 +277,7 @@ module Fox # # ==== Parameters: # - # +color+:: the blended color [FXColor] + # +color+:: the blended color {FXColor} # def blend(color); end @@ -295,7 +295,7 @@ module Fox # # ==== Parameters: # - # +store+:: opened stream to which to save the pixel data [FXStream] + # +store+:: opened stream to which to save the pixel data {FXStream} # def savePixels(store) ; end @@ -314,7 +314,7 @@ module Fox # # ==== Parameters: # - # +store+:: opened stream from which to read the pixel data [FXStream] + # +store+:: opened stream from which to read the pixel data {FXStream} # def loadPixels(store) ; end end diff --git a/rdoc-sources/FXImageFrame.rb b/rdoc-sources/FXImageFrame.rb index 46a745a..da09e25 100755 --- a/rdoc-sources/FXImageFrame.rb +++ b/rdoc-sources/FXImageFrame.rb @@ -4,7 +4,7 @@ module Fox # class FXImageFrame < FXFrame - # The current image being displayed [FXImage] + # The current image being displayed {FXImage} attr_accessor :image # @@ -18,8 +18,8 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this image frame [FXComposite] - # +img+:: the image to display [FXImage] + # +p+:: the parent window for this image frame {FXComposite} + # +img+:: the image to display {FXImage} # +opts+:: frame options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] diff --git a/rdoc-sources/FXImageView.rb b/rdoc-sources/FXImageView.rb index 23e8ba3..0eb4e88 100755 --- a/rdoc-sources/FXImageView.rb +++ b/rdoc-sources/FXImageView.rb @@ -19,7 +19,7 @@ module Fox # class FXImageView < FXScrollArea - # The image [FXImage] + # The image {FXImage} attr_accessor :image # Current alignment [Integer] diff --git a/rdoc-sources/FXJPGIcon.rb b/rdoc-sources/FXJPGIcon.rb index 46f89b4..e59bb68 100755 --- a/rdoc-sources/FXJPGIcon.rb +++ b/rdoc-sources/FXJPGIcon.rb @@ -25,9 +25,9 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in JPEG file format [String] - # +clr+:: transparency color [FXColor] + # +clr+:: transparency color {FXColor} # +opts+:: options [Integer] # +width+:: width [Integer] # +height+:: height [Integer] @@ -44,7 +44,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data {FXStream} # def Fox.fxloadJPG(store); end @@ -54,9 +54,9 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the image data [FXStream] + # +store+:: stream to which to write the image data {FXStream} # +data+:: the image pixel data [String] - # +transp+:: transparency color [FXColor] + # +transp+:: transparency color {FXColor} # +width+:: width [Integer] # +height+:: height [Integer] # +quality+:: image quality [Integer] diff --git a/rdoc-sources/FXJPGImage.rb b/rdoc-sources/FXJPGImage.rb index 6609ed5..32af2dd 100755 --- a/rdoc-sources/FXJPGImage.rb +++ b/rdoc-sources/FXJPGImage.rb @@ -25,7 +25,7 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in JPEG file format [String] # +opts+:: options [Integer] # +width+:: width [Integer] diff --git a/rdoc-sources/FXKnob.rb b/rdoc-sources/FXKnob.rb index 6a664c4..8d0e3ff 100644 --- a/rdoc-sources/FXKnob.rb +++ b/rdoc-sources/FXKnob.rb @@ -46,7 +46,7 @@ module Fox # Delta between ticks [Integer] attr_accessor :tickDelta - # Indicator needle color [FXColor] + # Indicator needle color {FXColor} attr_accessor :lineColor # Help text displayed on the status line [String] diff --git a/rdoc-sources/FXLabel.rb b/rdoc-sources/FXLabel.rb index f2f0a7d..ea54151 100755 --- a/rdoc-sources/FXLabel.rb +++ b/rdoc-sources/FXLabel.rb @@ -41,13 +41,13 @@ module Fox # The text for this label [String] attr_accessor :text - # The icon for this label [FXIcon] + # The icon for this label {FXIcon} attr_accessor :icon - # The text font [FXFont] + # The text font {FXFont} attr_accessor :font - # The text color [FXColor] + # The text color {FXColor} attr_accessor :textColor # Text justification mode [Integer] diff --git a/rdoc-sources/FXList.rb b/rdoc-sources/FXList.rb index 295e506..c3504fe 100755 --- a/rdoc-sources/FXList.rb +++ b/rdoc-sources/FXList.rb @@ -7,7 +7,7 @@ module Fox # Text for this item [String] attr_accessor :text - # Icon for this item [FXIcon] + # Icon for this item {FXIcon} attr_accessor :icon # User data for this item [Object] @@ -125,16 +125,16 @@ module Fox # Index of item under the cursor, or -1 if none [Integer] attr_reader :cursorItem - # Text font [FXFont] + # Text font {FXFont} attr_accessor :font - # Normal text color [FXColor] + # Normal text color {FXColor} attr_accessor :textColor - # Selected text background color [FXColor] + # Selected text background color {FXColor} attr_accessor :selBackColor - # Selected text color [FXColor] + # Selected text color {FXColor} attr_accessor :selTextColor # List style [Integer] diff --git a/rdoc-sources/FXListBox.rb b/rdoc-sources/FXListBox.rb index b5656f1..d5ef5e6 100755 --- a/rdoc-sources/FXListBox.rb +++ b/rdoc-sources/FXListBox.rb @@ -37,19 +37,19 @@ module Fox # Current item's index, or -1 if no current item [Integer] attr_accessor :currentItem - # Text font [FXFont] + # Text font {FXFont} attr_accessor :font - # Background color [FXColor] + # Background color {FXColor} attr_reader :backColor - # Text color [FXColor] + # Text color {FXColor} attr_accessor :textColor - # Background color for selected items [FXColor] + # Background color for selected items {FXColor} attr_accessor :selBackColor - # Text color for selected items [FXColor] + # Text color for selected items {FXColor} attr_accessor :selTextColor # Status line help text [String] diff --git a/rdoc-sources/FXMDIChild.rb b/rdoc-sources/FXMDIChild.rb index cf9d4ce..cfcc844 100755 --- a/rdoc-sources/FXMDIChild.rb +++ b/rdoc-sources/FXMDIChild.rb @@ -79,37 +79,37 @@ module Fox # Iconified height [Integer] attr_accessor :iconHeight - # Content window [FXWindow] + # Content window {FXWindow} attr_reader :contentWindow # Window title [String] attr_accessor :title - # Highlight color [FXColor] + # Highlight color {FXColor} attr_accessor :hiliteColor - # Shadow color [FXColor] + # Shadow color {FXColor} attr_accessor :shadowColor - # Base color [FXColor] + # Base color {FXColor} attr_accessor :baseColor - # Border color [FXColor] + # Border color {FXColor} attr_accessor :borderColor - # Title color [FXColor] + # Title color {FXColor} attr_accessor :titleColor - # Title background color [FXColor] + # Title background color {FXColor} attr_accessor :titleBackColor - # Window icon [FXIcon] + # Window icon {FXIcon} attr_accessor :icon - # Window menu [FXPopup] + # Window menu {FXPopup} attr_accessor :menu - # Title font [FXFont] + # Title font {FXFont} attr_accessor :font # Construct MDI Child window with given name and icon diff --git a/rdoc-sources/FXMDIClient.rb b/rdoc-sources/FXMDIClient.rb index 4e9b140..1dd61df 100755 --- a/rdoc-sources/FXMDIClient.rb +++ b/rdoc-sources/FXMDIClient.rb @@ -25,7 +25,7 @@ module Fox # class FXMDIClient < FXComposite - # Active MDI child window, or +nil+ if none [FXMDIChild]. + # Active MDI child window, or +nil+ if none {FXMDIChild}. attr_accessor :activeChild # Cascade offset X [Integer] diff --git a/rdoc-sources/FXMemoryStream.rb b/rdoc-sources/FXMemoryStream.rb index 594221a..9026d2e 100755 --- a/rdoc-sources/FXMemoryStream.rb +++ b/rdoc-sources/FXMemoryStream.rb @@ -17,7 +17,7 @@ module Fox # # ==== Parameters: # - # +cont+:: the container object, or +nil+ if there is none [FXObject]. + # +cont+:: the container object, or +nil+ if there is none {FXObject}. # def initialize(cont=nil) # :yields: theMemoryStream end diff --git a/rdoc-sources/FXMenuButton.rb b/rdoc-sources/FXMenuButton.rb index ea35dbb..03f0338 100755 --- a/rdoc-sources/FXMenuButton.rb +++ b/rdoc-sources/FXMenuButton.rb @@ -57,7 +57,7 @@ module Fox # class FXMenuButton < FXLabel - # The popup menu [FXPopup] + # The popup menu {FXPopup} attr_accessor :menu # X-offset where menu pops up relative to button [Integer] diff --git a/rdoc-sources/FXMenuCaption.rb b/rdoc-sources/FXMenuCaption.rb index 14b79f5..a22c05a 100755 --- a/rdoc-sources/FXMenuCaption.rb +++ b/rdoc-sources/FXMenuCaption.rb @@ -13,25 +13,25 @@ module Fox # The text for this menu [String] attr_accessor :text - # The icon for this menu [FXIcon] + # The icon for this menu {FXIcon} attr_accessor :icon - # The text font [FXFont] + # The text font {FXFont} attr_accessor :font - # Text color [FXColor] + # Text color {FXColor} attr_accessor :textColor - # Selection background color [FXColor] + # Selection background color {FXColor} attr_accessor :selBackColor - # Selection text color [FXColor] + # Selection text color {FXColor} attr_accessor :selTextColor - # Highlight color [FXColor] + # Highlight color {FXColor} attr_accessor :hiliteColor - # Shadow color [FXColor] + # Shadow color {FXColor} attr_accessor :shadowColor # Status line help text for this menu [String] diff --git a/rdoc-sources/FXMenuCascade.rb b/rdoc-sources/FXMenuCascade.rb index 0d03c35..002bb1d 100755 --- a/rdoc-sources/FXMenuCascade.rb +++ b/rdoc-sources/FXMenuCascade.rb @@ -5,7 +5,7 @@ module Fox # class FXMenuCascade < FXMenuCaption - # The popup menu [FXPopup] + # The popup menu {FXPopup} attr_accessor :menu # diff --git a/rdoc-sources/FXMenuCheck.rb b/rdoc-sources/FXMenuCheck.rb index 14515e1..65df9c8 100755 --- a/rdoc-sources/FXMenuCheck.rb +++ b/rdoc-sources/FXMenuCheck.rb @@ -17,7 +17,7 @@ module Fox # Check state, one of +TRUE+, +FALSE+ or +MAYBE+ attr_accessor :check - # Box background color [FXColor] + # Box background color {FXColor} attr_accessor :boxColor # diff --git a/rdoc-sources/FXMenuRadio.rb b/rdoc-sources/FXMenuRadio.rb index 35296bc..fb14c3a 100755 --- a/rdoc-sources/FXMenuRadio.rb +++ b/rdoc-sources/FXMenuRadio.rb @@ -20,7 +20,7 @@ module Fox # Radio button state, one of +TRUE+, +FALSE+ or +MAYBE+ attr_accessor :check - # Radio background color [FXColor] + # Radio background color {FXColor} attr_accessor :radioColor # diff --git a/rdoc-sources/FXMenuSeparator.rb b/rdoc-sources/FXMenuSeparator.rb index 7789665..385fd43 100755 --- a/rdoc-sources/FXMenuSeparator.rb +++ b/rdoc-sources/FXMenuSeparator.rb @@ -5,10 +5,10 @@ module Fox # class FXMenuSeparator < FXWindow - # Highlight color [FXColor] + # Highlight color {FXColor} attr_accessor :hiliteColor - # Shadow color [FXColor] + # Shadow color {FXColor} attr_accessor :shadowColor # diff --git a/rdoc-sources/FXMenuTitle.rb b/rdoc-sources/FXMenuTitle.rb index 92c4ba9..d06cd9e 100755 --- a/rdoc-sources/FXMenuTitle.rb +++ b/rdoc-sources/FXMenuTitle.rb @@ -14,7 +14,7 @@ module Fox # class FXMenuTitle < FXMenuCaption - # The popup menu [FXPopup] + # The popup menu {FXPopup} attr_accessor :menu # diff --git a/rdoc-sources/FXOptionMenu.rb b/rdoc-sources/FXOptionMenu.rb index 0d8e0db..c8be3ab 100755 --- a/rdoc-sources/FXOptionMenu.rb +++ b/rdoc-sources/FXOptionMenu.rb @@ -13,10 +13,10 @@ module Fox # +SEL_COMMAND+:: sent when this option is clicked; the message data is an FXEvent instance. # class FXOption < FXLabel - # Selection background color [FXColor] + # Selection background color {FXColor} attr_accessor :selBackColor - # Selection text color [FXColor] + # Selection text color {FXColor} attr_accessor :selTextColor # @@ -41,13 +41,13 @@ module Fox # class FXOptionMenu < FXLabel - # The current option, or +nil+ if none [FXOption] + # The current option, or +nil+ if none {FXOption} attr_accessor :current # The current option number, or -1 if none [Integer] attr_accessor :currentNo - # The pane which will be popped up [FXPopup] + # The pane which will be popped up {FXPopup} attr_accessor :menu # diff --git a/rdoc-sources/FXPCXIcon.rb b/rdoc-sources/FXPCXIcon.rb index b2edc14..f369a7d 100755 --- a/rdoc-sources/FXPCXIcon.rb +++ b/rdoc-sources/FXPCXIcon.rb @@ -18,9 +18,9 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in PCX file format [String] - # +clr+:: transparency color [FXColor] + # +clr+:: transparency color {FXColor} # +opts+:: options [Integer] # +width+:: width [Integer] # +height+:: height [Integer] @@ -37,7 +37,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data {FXStream} # def Fox.fxloadPCX(store); end @@ -47,9 +47,9 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the image data [FXStream] + # +store+:: stream to which to write the image data {FXStream} # +data+:: the image pixel data [String] - # +transp+:: transparency color [FXColor] + # +transp+:: transparency color {FXColor} # +width+:: width [Integer] # +height+:: height [Integer] # diff --git a/rdoc-sources/FXPCXImage.rb b/rdoc-sources/FXPCXImage.rb index 3ba4d07..7f614b3 100755 --- a/rdoc-sources/FXPCXImage.rb +++ b/rdoc-sources/FXPCXImage.rb @@ -18,7 +18,7 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in PCX file format [String] # +opts+:: options [Integer] # +width+:: width [Integer] diff --git a/rdoc-sources/FXPNGIcon.rb b/rdoc-sources/FXPNGIcon.rb index 0435c41..874dfcb 100755 --- a/rdoc-sources/FXPNGIcon.rb +++ b/rdoc-sources/FXPNGIcon.rb @@ -21,9 +21,9 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in PNG file format [String] - # +clr+:: transparency color [FXColor] + # +clr+:: transparency color {FXColor} # +opts+:: options [Integer] # +width+:: width [Integer] # +height+:: height [Integer] @@ -40,7 +40,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data {FXStream} # def Fox.fxloadPNG(store); end @@ -50,9 +50,9 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the image data [FXStream] + # +store+:: stream to which to write the image data {FXStream} # +data+:: the image pixel data [String] - # +transp+:: transparency color [FXColor] + # +transp+:: transparency color {FXColor} # +width+:: width [Integer] # +height+:: height [Integer] # diff --git a/rdoc-sources/FXPNGImage.rb b/rdoc-sources/FXPNGImage.rb index 384e613..eb949e8 100755 --- a/rdoc-sources/FXPNGImage.rb +++ b/rdoc-sources/FXPNGImage.rb @@ -21,7 +21,7 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in PNG file format [String] # +opts+:: options [Integer] # +width+:: width [Integer] diff --git a/rdoc-sources/FXPPMIcon.rb b/rdoc-sources/FXPPMIcon.rb index 1f072ba..b081fca 100755 --- a/rdoc-sources/FXPPMIcon.rb +++ b/rdoc-sources/FXPPMIcon.rb @@ -18,9 +18,9 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in PPM file format [String] - # +clr+:: transparency color [FXColor] + # +clr+:: transparency color {FXColor} # +opts+:: options [Integer] # +width+:: width [Integer] # +height+:: height [Integer] diff --git a/rdoc-sources/FXPPMImage.rb b/rdoc-sources/FXPPMImage.rb index 3851008..7a5a6f8 100755 --- a/rdoc-sources/FXPPMImage.rb +++ b/rdoc-sources/FXPPMImage.rb @@ -18,7 +18,7 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in PPM file format [String] # +opts+:: options [Integer] # +width+:: width [Integer] diff --git a/rdoc-sources/FXPacker.rb b/rdoc-sources/FXPacker.rb index 397e816..6e7f1a0 100755 --- a/rdoc-sources/FXPacker.rb +++ b/rdoc-sources/FXPacker.rb @@ -35,16 +35,16 @@ module Fox # Right padding, in pixels [Integer] attr_accessor :padRight - # Highlight color [FXColor] + # Highlight color {FXColor} attr_accessor :hiliteColor - # Shadow color [FXColor] + # Shadow color {FXColor} attr_accessor :shadowColor - # Border color [FXColor] + # Border color {FXColor} attr_accessor :borderColor - # Base GUI color [FXColor] + # Base GUI color {FXColor} attr_accessor :baseColor # Horizontal inter-child spacing, in pixels [Integer] diff --git a/rdoc-sources/FXPopup.rb b/rdoc-sources/FXPopup.rb index 7e5646d..6cca1cf 100755 --- a/rdoc-sources/FXPopup.rb +++ b/rdoc-sources/FXPopup.rb @@ -16,19 +16,19 @@ module Fox # Border width [Integer] attr_reader :borderWidth - # Highlight color [FXColor] + # Highlight color {FXColor} attr_accessor :hiliteColor - # Shadow color [FXColor] + # Shadow color {FXColor} attr_accessor :shadowColor - # Border color [FXColor] + # Border color {FXColor} attr_accessor :borderColor - # Base color [FXColor] + # Base color {FXColor} attr_accessor :baseColor - # Current grab owner [FXWindow] + # Current grab owner {FXWindow} attr_reader :grabOwner # Popup orientation [Integer] diff --git a/rdoc-sources/FXPrintDialog.rb b/rdoc-sources/FXPrintDialog.rb index 015e4f4..bb49c25 100755 --- a/rdoc-sources/FXPrintDialog.rb +++ b/rdoc-sources/FXPrintDialog.rb @@ -26,7 +26,7 @@ module Fox # +ID_NUM_COPIES+:: x # class FXPrintDialog < FXDialogBox - # Printer information [FXPrinter] + # Printer information {FXPrinter} attr_accessor :printer # Construct print dialog diff --git a/rdoc-sources/FXProgressBar.rb b/rdoc-sources/FXProgressBar.rb index 1e82488..ec4a9b8 100755 --- a/rdoc-sources/FXProgressBar.rb +++ b/rdoc-sources/FXProgressBar.rb @@ -20,19 +20,19 @@ module Fox # Bar width [Integer] attr_accessor :barSize - # Bar color [FXColor] + # Bar color {FXColor} attr_accessor :barColor - # Bar background color [FXColor] + # Bar background color {FXColor} attr_accessor :barBGColor - # Text color [FXColor] + # Text color {FXColor} attr_accessor :textColor - # Alternate text color [FXColor] + # Alternate text color {FXColor} attr_accessor :textAltColor - # Text font [FXFont] + # Text font {FXFont} attr_accessor :font # Progress bar style [Integer] diff --git a/rdoc-sources/FXQuatd.rb b/rdoc-sources/FXQuatd.rb index ca990f6..87f7252 100755 --- a/rdoc-sources/FXQuatd.rb +++ b/rdoc-sources/FXQuatd.rb @@ -8,7 +8,7 @@ module Fox # # ==== Parameters: # - # +axis+:: the rotation axis [FXVec3d] + # +axis+:: the rotation axis {FXVec3d} # +angle+:: the rotation angle (in radians) [Float] # def initialize(axis, phi=0.0); end @@ -51,7 +51,7 @@ module Fox # # ==== Parameters: # - # +axis+:: the rotation axis [FXVec3d] + # +axis+:: the rotation axis {FXVec3d} # +angle+:: the rotation angle (in radians) [Float] # def setAxisAngle(axis, phi=0.0); end @@ -135,7 +135,7 @@ module Fox # # ==== Parameters: # - # +vec+:: the vector to be rotated [FXVec3d] + # +vec+:: the vector to be rotated {FXVec3d} # def *(vec); end @@ -145,8 +145,8 @@ module Fox # # ==== Parameters: # - # +a+:: [FXVec3d] - # +b+:: [FXVec3d] + # +a+:: {FXVec3d} + # +b+:: {FXVec3d} # def arc!(a, b); end @@ -155,8 +155,8 @@ module Fox # # ==== Parameters: # - # +u+:: [FXQuatd] - # +v+:: [FXQuatd] + # +u+:: {FXQuatd} + # +v+:: {FXQuatd} # +f+:: [Float] # def lerp!(u, v, f); end diff --git a/rdoc-sources/FXQuatf.rb b/rdoc-sources/FXQuatf.rb index c137c81..da61491 100755 --- a/rdoc-sources/FXQuatf.rb +++ b/rdoc-sources/FXQuatf.rb @@ -8,7 +8,7 @@ module Fox # # ==== Parameters: # - # +axis+:: the rotation axis [FXVec3f] + # +axis+:: the rotation axis {FXVec3f} # +angle+:: the rotation angle (in radians) [Float] # def initialize(axis, phi=0.0); end @@ -29,9 +29,9 @@ module Fox # # ==== Parameters: # - # +ex+:: x-axis [FXVec3f] - # +ey+:: y-axis [FXVec3f] - # +ez+:: z-axis [FXVec3f] + # +ex+:: x-axis {FXVec3f} + # +ey+:: y-axis {FXVec3f} + # +ez+:: z-axis {FXVec3f} # def initialize(ex, ey, ez); end @@ -60,7 +60,7 @@ module Fox # # ==== Parameters: # - # +axis+:: the rotation axis [FXVec3f] + # +axis+:: the rotation axis {FXVec3f} # +angle+:: the rotation angle (in radians) [Float] # def setAxisAngle(axis, phi=0.0); end @@ -144,7 +144,7 @@ module Fox # # ==== Parameters: # - # +vec+:: the vector to be rotated [FXVec3f] + # +vec+:: the vector to be rotated {FXVec3f} # def *(vec); end @@ -154,8 +154,8 @@ module Fox # # ==== Parameters: # - # +a+:: [FXVec3f] - # +b+:: [FXVec3f] + # +a+:: {FXVec3f} + # +b+:: {FXVec3f} # def arc!(a, b); end @@ -164,8 +164,8 @@ module Fox # # ==== Parameters: # - # +u+:: [FXQuatf] - # +v+:: [FXQuatf] + # +u+:: {FXQuatf} + # +v+:: {FXQuatf} # +f+:: [Float] # def lerp!(u, v, f); end diff --git a/rdoc-sources/FXRGBIcon.rb b/rdoc-sources/FXRGBIcon.rb index cd3d562..2c2cdc1 100755 --- a/rdoc-sources/FXRGBIcon.rb +++ b/rdoc-sources/FXRGBIcon.rb @@ -18,9 +18,9 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in IRIS RGB file format [String] - # +clr+:: transparency color [FXColor] + # +clr+:: transparency color {FXColor} # +opts+:: options [Integer] # +width+:: width [Integer] # +height+:: height [Integer] @@ -37,7 +37,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data {FXStream} # def Fox.fxloadRGB(store); end @@ -47,9 +47,9 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the file data [FXStream] + # +store+:: stream to which to write the file data {FXStream} # +data+:: the image pixel data [String] - # +transp+:: transparency color [FXColor] + # +transp+:: transparency color {FXColor} # +opts+:: options [Integer] # +width+:: width [Integer] # +height+:: height [Integer] diff --git a/rdoc-sources/FXRGBImage.rb b/rdoc-sources/FXRGBImage.rb index c1f4194..a4715f7 100755 --- a/rdoc-sources/FXRGBImage.rb +++ b/rdoc-sources/FXRGBImage.rb @@ -18,7 +18,7 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in IRIS RGB file format [String] # +opts+:: options [Integer] # +width+:: width [Integer] diff --git a/rdoc-sources/FXRadioButton.rb b/rdoc-sources/FXRadioButton.rb index 079969f..dce8905 100755 --- a/rdoc-sources/FXRadioButton.rb +++ b/rdoc-sources/FXRadioButton.rb @@ -34,10 +34,10 @@ module Fox # Radio button style [Integer] attr_accessor :radioButtonStyle - # Radio ball color [FXColor] + # Radio ball color {FXColor} attr_accessor :radioColor - # Radio disk color [FXColor] + # Radio disk color {FXColor} attr_accessor :diskColor # diff --git a/rdoc-sources/FXRanged.rb b/rdoc-sources/FXRanged.rb index 18facaa..90bb80f 100755 --- a/rdoc-sources/FXRanged.rb +++ b/rdoc-sources/FXRanged.rb @@ -4,10 +4,10 @@ module Fox # class FXRanged - # Lower corner of range [FXVec3d] + # Lower corner of range {FXVec3d} attr_accessor :lower - # Upper corner of range [FXVec3d] + # Upper corner of range {FXVec3d} attr_accessor :upper # Default constructor diff --git a/rdoc-sources/FXRangef.rb b/rdoc-sources/FXRangef.rb index fc0656f..b040ff9 100755 --- a/rdoc-sources/FXRangef.rb +++ b/rdoc-sources/FXRangef.rb @@ -4,10 +4,10 @@ module Fox # class FXRangef - # Lower corner of range [FXVec3f] + # Lower corner of range {FXVec3f} attr_accessor :lower - # Upper corner of range [FXVec3f] + # Upper corner of range {FXVec3f} attr_accessor :upper # Default constructor diff --git a/rdoc-sources/FXRealSlider.rb b/rdoc-sources/FXRealSlider.rb index c7da6c9..723df69 100755 --- a/rdoc-sources/FXRealSlider.rb +++ b/rdoc-sources/FXRealSlider.rb @@ -61,7 +61,7 @@ module Fox # Delta between ticks [Float] attr_accessor :tickDelta - # Color of the slot that the slider head moves in [FXColor] + # Color of the slot that the slider head moves in {FXColor} attr_accessor :slotColor # Status line help text for this slider [String] @@ -75,8 +75,8 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this slider [FXComposite] - # +target+:: the message target, if any, for this slider [FXObject] + # +p+:: the parent window for this slider {FXComposite} + # +target+:: the message target, if any, for this slider {FXObject} # +selector+:: the message identifier for this slider [Integer] # +opts+:: slider options [Integer] # +x+:: initial x-position, when the +LAYOUT_FIX_X+ layout hint is in effect [Integer] diff --git a/rdoc-sources/FXRealSpinner.rb b/rdoc-sources/FXRealSpinner.rb index 3d9ffe9..f4405b1 100755 --- a/rdoc-sources/FXRealSpinner.rb +++ b/rdoc-sources/FXRealSpinner.rb @@ -37,7 +37,7 @@ module Fox # Spinner range (low and high values) [Range] attr_accessor :range - # Text font for this spinner [FXFont] + # Text font for this spinner {FXFont} attr_accessor :font # Status line help text for this spinner [String] @@ -49,22 +49,22 @@ module Fox # Spinner style [Integer] attr_accessor :spinnerStyle - # Color of the "up" arrow [FXColor] + # Color of the "up" arrow {FXColor} attr_accessor :upArrowColor - # Color of the "down" arrow [FXColor] + # Color of the "down" arrow {FXColor} attr_accessor :downArrowColor - # Normal text color [FXColor] + # Normal text color {FXColor} attr_accessor :textColor - # Background color for selected text [FXColor] + # Background color for selected text {FXColor} attr_accessor :selBackColor - # Foreground color for selected text [FXColor] + # Foreground color for selected text {FXColor} attr_accessor :selTextColor - # Cursor color [FXColor] + # Cursor color {FXColor} attr_accessor :cursorColor # Number of columns (i.e. width of spinner's text field, in terms of number of columns of 'm') [Integer] @@ -78,9 +78,9 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this spinner [FXComposite] + # +p+:: the parent window for this spinner {FXComposite} # +cols+:: number of columns to display in the text field [Integer] - # +target+:: the message target, if any, for this spinner [FXObject] + # +target+:: the message target, if any, for this spinner {FXObject} # +selector+:: the message identifier for this spinner [Integer] # +opts+:: the options [Integer] # +x+:: initial x-position [Integer] diff --git a/rdoc-sources/FXRecentFiles.rb b/rdoc-sources/FXRecentFiles.rb index 69a7475..d55020a 100755 --- a/rdoc-sources/FXRecentFiles.rb +++ b/rdoc-sources/FXRecentFiles.rb @@ -35,7 +35,7 @@ module Fox # <tt>ID_FILE_10</tt>:: x # class FXRecentFiles < FXObject - # Application associated with this recent files group [FXApp] + # Application associated with this recent files group {FXApp} attr_reader :app # Maximum number of files to track [Integer] @@ -44,7 +44,7 @@ module Fox # Group name [String] attr_accessor :groupName - # Message target [FXObject] + # Message target {FXObject} attr_accessor :target # Message identifier [Integer] diff --git a/rdoc-sources/FXRectangle.rb b/rdoc-sources/FXRectangle.rb index 8126b80..1ee9adb 100755 --- a/rdoc-sources/FXRectangle.rb +++ b/rdoc-sources/FXRectangle.rb @@ -40,8 +40,8 @@ module Fox # # ==== Parameters: # - # +p+:: upper left corner's initial position [FXPoint] - # +s+:: initial size [FXSize] + # +p+:: upper left corner's initial position {FXPoint} + # +s+:: initial size {FXSize} # def initialize(p, s); end @@ -50,8 +50,8 @@ module Fox # # ==== Parameters: # - # +topleft+:: upper left corner's initial position [FXPoint] - # +bottomright+:: bottom right corner's initial position [FXPoint] + # +topleft+:: upper left corner's initial position {FXPoint} + # +bottomright+:: bottom right corner's initial position {FXPoint} # def initialize(topleft, bottomright); end diff --git a/rdoc-sources/FXReplaceDialog.rb b/rdoc-sources/FXReplaceDialog.rb index 06e12ef..0e702ab 100755 --- a/rdoc-sources/FXReplaceDialog.rb +++ b/rdoc-sources/FXReplaceDialog.rb @@ -40,9 +40,9 @@ module Fox # # ==== Parameters: # - # +owner+:: the owner window for this dialog box [FXWindow] + # +owner+:: the owner window for this dialog box {FXWindow} # +caption+:: the caption (title) string for this dialog box [String] - # +ic+:: the icon [FXIcon] + # +ic+:: the icon {FXIcon} # +opts+:: the options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] diff --git a/rdoc-sources/FXRootWindow.rb b/rdoc-sources/FXRootWindow.rb index c5a554a..ce0e8db 100755 --- a/rdoc-sources/FXRootWindow.rb +++ b/rdoc-sources/FXRootWindow.rb @@ -8,8 +8,8 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +vis+:: a visual [FXVisual] + # +a+:: an application instance {FXApp} + # +vis+:: a visual {FXVisual} # def initialize(a, vis) # :yield: theRootWindow end diff --git a/rdoc-sources/FXRuler.rb b/rdoc-sources/FXRuler.rb index eb68845..e3d2c6b 100755 --- a/rdoc-sources/FXRuler.rb +++ b/rdoc-sources/FXRuler.rb @@ -94,7 +94,7 @@ module Fox # Pixels per tick spacing [Float] attr_accessor :pixelsPerTick - # The text font [FXFont] + # The text font {FXFont} attr_accessor :font # The slider value [Integer] @@ -106,7 +106,7 @@ module Fox # Ruler alignment [Integer] attr_accessor :rulerAlignment - # The current text color [FXColor] + # The current text color {FXColor} attr_accessor :textColor # The status line help text for this ruler [String] diff --git a/rdoc-sources/FXRulerView.rb b/rdoc-sources/FXRulerView.rb index 47d02be..5fa98a6 100755 --- a/rdoc-sources/FXRulerView.rb +++ b/rdoc-sources/FXRulerView.rb @@ -9,10 +9,10 @@ module Fox # class FXRulerView < FXScrollArea - # Return a reference to the horizontal ruler [FXRuler] + # Return a reference to the horizontal ruler {FXRuler} attr_reader :horizontalRuler - # Return a reference to the vertical ruler [FXRuler] + # Return a reference to the vertical ruler {FXRuler} attr_reader :verticalRuler # Get document position X [Integer] @@ -21,7 +21,7 @@ module Fox # Get document position Y [Integer] attr_reader :documentY - # Current document color [FXColor] + # Current document color {FXColor} attr_accessor :documentColor # X arrow position, relative to document position [Integer] @@ -72,10 +72,10 @@ module Fox # Vertical alignment; the default is +RULER_ALIGN_NORMAL+ [Integer] attr_accessor :vAlignment - # Horizontal ruler font [FXFont] + # Horizontal ruler font {FXFont} attr_accessor :hRulerFont - # Vertical ruler font [FXFont] + # Vertical ruler font {FXFont} attr_accessor :vRulerFont # Horizontal document number placement [Integer] diff --git a/rdoc-sources/FXScrollArea.rb b/rdoc-sources/FXScrollArea.rb index eb7bb59..f48a642 100755 --- a/rdoc-sources/FXScrollArea.rb +++ b/rdoc-sources/FXScrollArea.rb @@ -44,10 +44,10 @@ module Fox # Scroll style [Integer] attr_accessor :scrollStyle - # Horizontal scrollbar [FXScrollBar] + # Horizontal scrollbar {FXScrollBar} attr_reader :horizontalScrollBar - # Vertical scrollbar [FXScrollBar] + # Vertical scrollbar {FXScrollBar} attr_reader :verticalScrollBar # Current x-position [Integer] @@ -61,7 +61,7 @@ module Fox # # ==== Parameters: # - # +parent+:: the parent widget for this scroll area [FXComposite] + # +parent+:: the parent widget for this scroll area {FXComposite} # +opts+:: the options [Integer] # +x+:: initial x-position, when the +LAYOUT_FIX_X+ layout hint is in effect [Integer] # +y+:: initial y-position, when the +LAYOUT_FIX_Y+ layout hint is in effect [Integer] diff --git a/rdoc-sources/FXScrollBar.rb b/rdoc-sources/FXScrollBar.rb index a3f0ff0..daadba0 100755 --- a/rdoc-sources/FXScrollBar.rb +++ b/rdoc-sources/FXScrollBar.rb @@ -59,13 +59,13 @@ module Fox # Current scroll position [Integer] attr_accessor :position - # Highlight color [FXColor] + # Highlight color {FXColor} attr_accessor :hiliteColor - # Shadow color [FXColor] + # Shadow color {FXColor} attr_accessor :shadowColor - # Border color [FXColor] + # Border color {FXColor} attr_accessor :borderColor # Scroll bar style [Integer] @@ -79,8 +79,8 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this scroll bar [FXComposite] - # +target+:: the initial message target (if any) for this scroll bar [FXObject] + # +p+:: the parent widget for this scroll bar {FXComposite} + # +target+:: the initial message target (if any) for this scroll bar {FXObject} # +selector+:: the message identifier for this scroll bar [Integer] # +opts+:: the options [Integer] # +x+:: initial x-position, when the +LAYOUT_FIX_X+ layout hint is in effect [Integer] diff --git a/rdoc-sources/FXScrollPane.rb b/rdoc-sources/FXScrollPane.rb index e7455e5..15448b1 100755 --- a/rdoc-sources/FXScrollPane.rb +++ b/rdoc-sources/FXScrollPane.rb @@ -17,7 +17,7 @@ module Fox # # ==== Parameters: # - # +owner+:: owner window for this menu pane [FXWindow] + # +owner+:: owner window for this menu pane {FXWindow} # +nvis+:: maximum number of visible items [Integer] # +opts+:: options [Integer] # diff --git a/rdoc-sources/FXScrollWindow.rb b/rdoc-sources/FXScrollWindow.rb index a3dcf55..d4cdbc5 100755 --- a/rdoc-sources/FXScrollWindow.rb +++ b/rdoc-sources/FXScrollWindow.rb @@ -19,7 +19,7 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this scroll window [FXComposite] + # +p+:: the parent window for this scroll window {FXComposite} # +opts+:: the options [Integer] # +x+:: initial x-position, when the +LAYOUT_FIX_X+ layout hint is in effect [Integer] # +y+:: initial y-position, when the +LAYOUT_FIX_Y+ layout hint is in effect [Integer] diff --git a/rdoc-sources/FXSearchDialog.rb b/rdoc-sources/FXSearchDialog.rb index 6702b7e..53ecb90 100755 --- a/rdoc-sources/FXSearchDialog.rb +++ b/rdoc-sources/FXSearchDialog.rb @@ -8,9 +8,9 @@ module Fox # # ==== Parameters: # - # +owner+:: the owner window for this dialog box [FXWindow] + # +owner+:: the owner window for this dialog box {FXWindow} # +caption+:: the caption (title) string for this dialog box [String] - # +ic+:: the icon [FXIcon] + # +ic+:: the icon {FXIcon} # +opts+:: the options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] diff --git a/rdoc-sources/FXSeparator.rb b/rdoc-sources/FXSeparator.rb index 995cf04..e170f20 100755 --- a/rdoc-sources/FXSeparator.rb +++ b/rdoc-sources/FXSeparator.rb @@ -32,7 +32,7 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this separator [FXComposite] + # +p+:: the parent widget for this separator {FXComposite} # +opts+:: the options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] @@ -56,7 +56,7 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this separator [FXComposite] + # +p+:: the parent widget for this separator {FXComposite} # +opts+:: the options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] diff --git a/rdoc-sources/FXSettings.rb b/rdoc-sources/FXSettings.rb index 44f6133..37186be 100755 --- a/rdoc-sources/FXSettings.rb +++ b/rdoc-sources/FXSettings.rb @@ -107,7 +107,7 @@ module Fox # # +section+:: the section name [String] # +key+:: the key for the setting of interest [String] - # +default+:: the default value to return if _key_ is not found [FXColor] + # +default+:: the default value to return if _key_ is not found {FXColor} # def readColorEntry(section, key, default=0) ; end @@ -179,7 +179,7 @@ module Fox # # +section+:: the section name [String] # +key+:: the key for this setting [String] - # +value+:: the value for this setting [FXColor] + # +value+:: the value for this setting {FXColor} # def writeColorEntry(section, key, value) ; end diff --git a/rdoc-sources/FXShutter.rb b/rdoc-sources/FXShutter.rb index 68c1f2a..d690183 100755 --- a/rdoc-sources/FXShutter.rb +++ b/rdoc-sources/FXShutter.rb @@ -11,11 +11,11 @@ module Fox # class FXShutterItem < FXVerticalFrame # - # The button for this shutter item [FXButton] + # The button for this shutter item {FXButton} # attr_reader :button - # The contents for this shutter item [FXVerticalFrame] + # The contents for this shutter item {FXVerticalFrame} attr_reader :content # Status line help text for this shutter item [String] @@ -29,9 +29,9 @@ module Fox # # ==== Parameters: # - # +p+:: the parent shutter for this shutter item [FXShutter] + # +p+:: the parent shutter for this shutter item {FXShutter} # +text+:: the text, if any [String] - # +icon+:: the icon, if any [FXIcon] + # +icon+:: the icon, if any {FXIcon} # +opts+:: options [Integer] # +x+:: initial x-position, when the +LAYOUT_FIX_X+ layout hint is in effect [Integer] # +y+:: initial y-position, when the +LAYOUT_FIX_Y+ layout hint is in effect [Integer] @@ -80,8 +80,8 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this shutter [FXComposite] - # +target+:: the message target, if any, for this shutter [FXObject] + # +p+:: the parent window for this shutter {FXComposite} + # +target+:: the message target, if any, for this shutter {FXObject} # +selector+:: the message identifier for this shutter [Integer] # +opts+:: shutter options [Integer] # +x+:: initial x-position [Integer] diff --git a/rdoc-sources/FXSlider.rb b/rdoc-sources/FXSlider.rb index 12968fe..b3279ee 100755 --- a/rdoc-sources/FXSlider.rb +++ b/rdoc-sources/FXSlider.rb @@ -64,7 +64,7 @@ module Fox # Delta between ticks [Integer] attr_accessor :tickDelta - # Color of the slot that the slider head moves in [FXColor] + # Color of the slot that the slider head moves in {FXColor} attr_accessor :slotColor # Status line help text for this slider [String] @@ -78,8 +78,8 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this slider [FXComposite] - # +target+:: the message target, if any, for this slider [FXObject] + # +p+:: the parent window for this slider {FXComposite} + # +target+:: the message target, if any, for this slider {FXObject} # +selector+:: the message identifier for this slider [Integer] # +opts+:: slider options [Integer] # +x+:: initial x-position, when the +LAYOUT_FIX_X+ layout hint is in effect [Integer] diff --git a/rdoc-sources/FXSphered.rb b/rdoc-sources/FXSphered.rb index c6c4dcd..b3d51f2 100755 --- a/rdoc-sources/FXSphered.rb +++ b/rdoc-sources/FXSphered.rb @@ -3,7 +3,7 @@ module Fox # Spherical bounds # class FXSphered - # Sphere center [FXVec3d] + # Sphere center {FXVec3d} attr_accessor :center # Sphere radius [Float] diff --git a/rdoc-sources/FXSpheref.rb b/rdoc-sources/FXSpheref.rb index b790bd7..4f6bc49 100755 --- a/rdoc-sources/FXSpheref.rb +++ b/rdoc-sources/FXSpheref.rb @@ -3,7 +3,7 @@ module Fox # Spherical bounds # class FXSpheref - # Sphere center [FXVec3f] + # Sphere center {FXVec3f} attr_accessor :center # Sphere radius [Float] diff --git a/rdoc-sources/FXSpinner.rb b/rdoc-sources/FXSpinner.rb index 29c5bbd..1bd51c9 100755 --- a/rdoc-sources/FXSpinner.rb +++ b/rdoc-sources/FXSpinner.rb @@ -36,7 +36,7 @@ module Fox # Spinner range (low and high values) [Range] attr_accessor :range - # Text font for this spinner [FXFont] + # Text font for this spinner {FXFont} attr_accessor :font # Status line help text for this spinner [String] @@ -48,22 +48,22 @@ module Fox # Spinner style [Integer] attr_accessor :spinnerStyle - # Color of the "up" arrow [FXColor] + # Color of the "up" arrow {FXColor} attr_accessor :upArrowColor - # Color of the "down" arrow [FXColor] + # Color of the "down" arrow {FXColor} attr_accessor :downArrowColor - # Normal text color [FXColor] + # Normal text color {FXColor} attr_accessor :textColor - # Background color for selected text [FXColor] + # Background color for selected text {FXColor} attr_accessor :selBackColor - # Foreground color for selected text [FXColor] + # Foreground color for selected text {FXColor} attr_accessor :selTextColor - # Cursor color [FXColor] + # Cursor color {FXColor} attr_accessor :cursorColor # Number of columns (i.e. width of spinner's text field, in terms of number of columns of 'm') [Integer] @@ -74,9 +74,9 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this spinner [FXComposite] + # +p+:: the parent window for this spinner {FXComposite} # +cols+:: number of columns to display in the text field [Integer] - # +target+:: the message target, if any, for this spinner [FXObject] + # +target+:: the message target, if any, for this spinner {FXObject} # +selector+:: the message identifier for this spinner [Integer] # +opts+:: the options [Integer] # +x+:: initial x-position [Integer] diff --git a/rdoc-sources/FXSplashWindow.rb b/rdoc-sources/FXSplashWindow.rb index bedf60c..56f8dce 100644 --- a/rdoc-sources/FXSplashWindow.rb +++ b/rdoc-sources/FXSplashWindow.rb @@ -13,7 +13,7 @@ module Fox # +SPLASH_DESTROY+:: Splash window will destroy itself when timer expires # class FXSplashWindow < FXTopWindow - # The splash window's icon [FXIcon] + # The splash window's icon {FXIcon} attr_accessor :icon # The delay before hiding the splash window, in milliseconds [Integer] diff --git a/rdoc-sources/FXSplitter.rb b/rdoc-sources/FXSplitter.rb index 1187f9d..64b5e7b 100755 --- a/rdoc-sources/FXSplitter.rb +++ b/rdoc-sources/FXSplitter.rb @@ -46,7 +46,7 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this splitter [FXComposite] + # +p+:: the parent widget for this splitter {FXComposite} # +opts+:: the options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] @@ -61,8 +61,8 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this splitter [FXComposite] - # +target+:: the message target for this splitter [FXObject] + # +p+:: the parent widget for this splitter {FXComposite} + # +target+:: the message target for this splitter {FXObject} # +selector+:: the message identifier for this splitter [Integer] # +opts+:: the options [Integer] # +x+:: initial x-position [Integer] diff --git a/rdoc-sources/FXSpring.rb b/rdoc-sources/FXSpring.rb index 14a1e1d..29c2e65 100755 --- a/rdoc-sources/FXSpring.rb +++ b/rdoc-sources/FXSpring.rb @@ -39,7 +39,7 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this spring [FXComposite] + # +p+:: the parent widget for this spring {FXComposite} # +relw+:: the relative width [Integer] # +relh+:: the relative height [Integer] # +opts+:: the options [Integer] diff --git a/rdoc-sources/FXStatusBar.rb b/rdoc-sources/FXStatusBar.rb index cb43db4..8c47a9b 100755 --- a/rdoc-sources/FXStatusBar.rb +++ b/rdoc-sources/FXStatusBar.rb @@ -8,10 +8,10 @@ module Fox # class FXStatusBar < FXHorizontalFrame - # The status line widget [FXStatusLine] + # The status line widget {FXStatusLine} attr_reader :statusLine - # The drag corner widget [FXDragCorner] + # The drag corner widget {FXDragCorner} attr_reader :dragCorner # If +true+, the drag corner is shown [Boolean] @@ -22,7 +22,7 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this status bar [FXComposite] + # +p+:: the parent window for this status bar {FXComposite} # +opts+:: status bar options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] diff --git a/rdoc-sources/FXStatusLine.rb b/rdoc-sources/FXStatusLine.rb index e2187f4..d8df1f5 100755 --- a/rdoc-sources/FXStatusLine.rb +++ b/rdoc-sources/FXStatusLine.rb @@ -30,13 +30,13 @@ module Fox # Permanent status message [String] attr_accessor :normalText - # Text font [FXFont] + # Text font {FXFont} attr_accessor :font - # Text color [FXColor] + # Text color {FXColor} attr_accessor :textColor - # Highlight text color [FXColor] + # Highlight text color {FXColor} attr_accessor :textHighlightColor # @@ -44,8 +44,8 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this shutter [FXComposite] - # +target+:: the message target, if any, for this shutter [FXObject] + # +p+:: the parent window for this shutter {FXComposite} + # +target+:: the message target, if any, for this shutter {FXObject} # +selector+:: the message identifier for this shutter [Integer] # def initialize(p, target=nil, selector=0) # :yields: theStatusLine diff --git a/rdoc-sources/FXStream.rb b/rdoc-sources/FXStream.rb index 7337c95..0562b7d 100755 --- a/rdoc-sources/FXStream.rb +++ b/rdoc-sources/FXStream.rb @@ -52,7 +52,7 @@ module Fox # Stream direction, one of +FXStreamSave+, +FXStreamLoad+ or +FXStreamDead+. attr_reader :direction - # Parent object [FXObject] + # Parent object {FXObject} attr_reader :container # Available buffer space @@ -69,7 +69,7 @@ module Fox # # ==== Parameters: # - # +cont+:: the container object, or +nil+ if there is none [FXObject]. + # +cont+:: the container object, or +nil+ if there is none {FXObject}. # def initialize(cont=nil) # :yields: theStream end diff --git a/rdoc-sources/FXSwitcher.rb b/rdoc-sources/FXSwitcher.rb index d52132b..bf3d6e7 100755 --- a/rdoc-sources/FXSwitcher.rb +++ b/rdoc-sources/FXSwitcher.rb @@ -53,7 +53,7 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this switcher [FXComposite] + # +p+:: the parent window for this switcher {FXComposite} # +opts+:: switcher options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] diff --git a/rdoc-sources/FXTGAIcon.rb b/rdoc-sources/FXTGAIcon.rb index 75e7367..35f54c5 100755 --- a/rdoc-sources/FXTGAIcon.rb +++ b/rdoc-sources/FXTGAIcon.rb @@ -18,9 +18,9 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in Targa file format [String] - # +clr+:: transparency color [FXColor] + # +clr+:: transparency color {FXColor} # +opts+:: options [Integer] # +width+:: width [Integer] # +height+:: height [Integer] @@ -37,7 +37,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data {FXStream} # def Fox.fxloadTGA(store); end @@ -47,7 +47,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the image data [FXStream] + # +store+:: stream to which to write the image data {FXStream} # +data+:: the image pixel data [String] # +channels+:: number of channels in the image pixel data: 3 for RGB data, or 4 for RGBA data [Integer] # +width+:: width [Integer] diff --git a/rdoc-sources/FXTGAImage.rb b/rdoc-sources/FXTGAImage.rb index 113c758..b24ba36 100755 --- a/rdoc-sources/FXTGAImage.rb +++ b/rdoc-sources/FXTGAImage.rb @@ -18,7 +18,7 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in Targa file format [String] # +opts+:: options [Integer] # +width+:: width [Integer] diff --git a/rdoc-sources/FXTIFIcon.rb b/rdoc-sources/FXTIFIcon.rb index 552d3ed..31788e0 100755 --- a/rdoc-sources/FXTIFIcon.rb +++ b/rdoc-sources/FXTIFIcon.rb @@ -24,9 +24,9 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in TIFF file format [String] - # +clr+:: transparency color [FXColor] + # +clr+:: transparency color {FXColor} # +opts+:: options [Integer] # +width+:: width [Integer] # +height+:: height [Integer] @@ -43,7 +43,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data {FXStream} # def Fox.fxloadTIF(store); end @@ -53,9 +53,9 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the image data [FXStream] + # +store+:: stream to which to write the image data {FXStream} # +data+:: the image pixel data [String] - # +transp+:: transparency color [FXColor] + # +transp+:: transparency color {FXColor} # +width+:: width [Integer] # +height+:: height [Integer] # +codec+:: codec setting [Integer] diff --git a/rdoc-sources/FXTIFImage.rb b/rdoc-sources/FXTIFImage.rb index d8ee71a..a95dcb6 100755 --- a/rdoc-sources/FXTIFImage.rb +++ b/rdoc-sources/FXTIFImage.rb @@ -24,7 +24,7 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in TIF file format [String] # +opts+:: options [Integer] # +width+:: width [Integer] diff --git a/rdoc-sources/FXTabBar.rb b/rdoc-sources/FXTabBar.rb index f7d3a63..b97cca8 100755 --- a/rdoc-sources/FXTabBar.rb +++ b/rdoc-sources/FXTabBar.rb @@ -53,8 +53,8 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this tar bar [FXComposite] - # +target+:: the message target, if any, for this tar bar [FXObject] + # +p+:: the parent window for this tar bar {FXComposite} + # +target+:: the message target, if any, for this tar bar {FXObject} # +selector+:: the message identifier for this tab bar [Integer] # +opts+:: tar bar options [Integer] # +x+:: initial x-position [Integer] diff --git a/rdoc-sources/FXTabBook.rb b/rdoc-sources/FXTabBook.rb index 21480d3..026f241 100755 --- a/rdoc-sources/FXTabBook.rb +++ b/rdoc-sources/FXTabBook.rb @@ -21,8 +21,8 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this tar book [FXComposite] - # +target+:: the message target, if any, for this tar book [FXObject] + # +p+:: the parent window for this tar book {FXComposite} + # +target+:: the message target, if any, for this tar book {FXObject} # +selector+:: the message identifier for this tab book [Integer] # +opts+:: tar book options [Integer] # +x+:: initial x-position [Integer] diff --git a/rdoc-sources/FXTabItem.rb b/rdoc-sources/FXTabItem.rb index 49724f0..9d6eea5 100755 --- a/rdoc-sources/FXTabItem.rb +++ b/rdoc-sources/FXTabItem.rb @@ -38,9 +38,9 @@ module Fox # # ==== Parameters: # - # +p+:: the parent tab book (or tab bar) for this tab item [FXTabBar] + # +p+:: the parent tab book (or tab bar) for this tab item {FXTabBar} # +text+:: the text for this tab item [String] - # +ic+:: the icon for this tab item, if any [FXIcon] + # +ic+:: the icon for this tab item, if any {FXIcon} # +opts+:: tab item options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] diff --git a/rdoc-sources/FXTable.rb b/rdoc-sources/FXTable.rb index c4b956a..7ac334b 100755 --- a/rdoc-sources/FXTable.rb +++ b/rdoc-sources/FXTable.rb @@ -19,10 +19,10 @@ module Fox # Represents a range of cells in an FXTable. # class FXTableRange - # Starting position for this range of cells [FXTablePos] + # Starting position for this range of cells {FXTablePos} attr_accessor :fm - # Ending position for this range of cells [FXTablePos] + # Ending position for this range of cells {FXTablePos} attr_accessor :to # @@ -39,7 +39,7 @@ module Fox # Text associated with this cell [String] attr_accessor :text - # Icon associated with this cell [FXIcon] + # Icon associated with this cell {FXIcon} attr_accessor :icon # User data associated with this cell [Object] @@ -82,7 +82,7 @@ module Fox # ==== Parameters: # # +text+:: the text for this table item [String] - # +icon+:: the icon, if any, for this table item [FXIcon] + # +icon+:: the icon, if any, for this table item {FXIcon} # +data+:: the user data for this table item [Object] # def initialize(text, icon=nil, data=nil); end @@ -261,13 +261,13 @@ module Fox class FXTable < FXScrollArea - # Button in the upper left corner [FXButton] + # Button in the upper left corner {FXButton} attr_reader :cornerButton - # Column header control [FXHeader] + # Column header control {FXHeader} attr_reader :columnHeader - # Row header control [FXHeader] + # Row header control {FXHeader} attr_reader :rowHeader # Number of visible rows [Integer] @@ -309,10 +309,10 @@ module Fox # attribute. attr_accessor :rowHeaderMode - # Row header font [FXFont] + # Row header font {FXFont} attr_accessor :rowHeaderFont - # Column header font [FXFont] + # Column header font {FXFont} attr_accessor :columnHeaderFont # The fixed column header height, if _columnHeaderMode_ is +LAYOUT_FIX_HEIGHT+. @@ -351,37 +351,37 @@ module Fox # Ending column number for selection, or -1 if there is no selection [Integer] attr_reader :selEndColumn - # Text font [FXFont] + # Text font {FXFont} attr_accessor :font - # Text color [FXColor] + # Text color {FXColor} attr_accessor :textColor - # Base GUI color [FXColor] + # Base GUI color {FXColor} attr_accessor :baseColor - # Highlight color [FXColor] + # Highlight color {FXColor} attr_accessor :hiliteColor - # Shadow color [FXColor] + # Shadow color {FXColor} attr_accessor :shadowColor - # Border color [FXColor] + # Border color {FXColor} attr_accessor :borderColor - # Background color for selected cell(s) [FXColor] + # Background color for selected cell(s) {FXColor} attr_accessor :selBackColor - # Text color for selected cell(s) [FXColor] + # Text color for selected cell(s) {FXColor} attr_accessor :selTextColor - # Grid color [FXColor] + # Grid color {FXColor} attr_accessor :gridColor - # Stipple color [FXColor] + # Stipple color {FXColor} attr_accessor :stippleColor - # Cell border color [FXColor] + # Cell border color {FXColor} attr_accessor :cellBorderColor # Cell border width, in pixels [Integer] @@ -403,8 +403,8 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this table [FXComposite] - # +target+:: the message target (if any) for this table [FXObject] + # +p+:: the parent window for this table {FXComposite} + # +target+:: the message target (if any) for this table {FXObject} # +selector+:: the message identifier for this table [Integer] # +opts+:: table options [Integer] # +x+:: initial x-position [Integer] diff --git a/rdoc-sources/FXText.rb b/rdoc-sources/FXText.rb index 5c6f2f4..635d566 100755 --- a/rdoc-sources/FXText.rb +++ b/rdoc-sources/FXText.rb @@ -3,25 +3,25 @@ module Fox # Highlight style entry # class FXHiliteStyle - # Normal text foreground color [FXColor] + # Normal text foreground color {FXColor} attr_accessor :normalForeColor - # Normal text background color [FXColor] + # Normal text background color {FXColor} attr_accessor :normalBackColor - # Selected text foreground color [FXColor] + # Selected text foreground color {FXColor} attr_accessor :selectForeColor - # Selected text background color [FXColor] + # Selected text background color {FXColor} attr_accessor :selectBackColor - # Highlight text foreground color [FXColor] + # Highlight text foreground color {FXColor} attr_accessor :hiliteForeColor - # Highlight text background color [FXColor] + # Highlight text background color {FXColor} attr_accessor :hiliteBackColor - # Active text background color [FXColor] + # Active text background color {FXColor} attr_accessor :activeBackColor # Highlight text style [Integer] @@ -229,34 +229,34 @@ module Fox # Word delimiters [String] attr_accessor :delimiters - # Text font [FXFont] + # Text font {FXFont} attr_accessor :font - # Text color [FXColor] + # Text color {FXColor} attr_accessor :textColor - # Selected text background color [FXColor] + # Selected text background color {FXColor} attr_accessor :selBackColor - # Selected text color [FXColor] + # Selected text color {FXColor} attr_accessor :selTextColor - # Highlight text color [FXColor] + # Highlight text color {FXColor} attr_accessor :hiliteTextColor - # Highlight text background color [FXColor] + # Highlight text background color {FXColor} attr_accessor :hiliteBackColor - # Active background color [FXColor] + # Active background color {FXColor} attr_accessor :activeBackColor - # Cursor color [FXColor] + # Cursor color {FXColor} attr_accessor :cursorColor - # Line number color [FXColor] + # Line number color {FXColor} attr_accessor :numberColor - # Bar color [FXColor] + # Bar color {FXColor} attr_accessor :barColor # Status line help text [String] @@ -312,8 +312,8 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this text widget [FXComposite] - # +target+:: the message target, if any, for this text widget [FXObject] + # +p+:: the parent window for this text widget {FXComposite} + # +target+:: the message target, if any, for this text widget {FXObject} # +selector+:: the message identifier for this text widget [Integer] # +opts+:: text options [Integer] # +x+:: initial x-position [Integer] diff --git a/rdoc-sources/FXTextField.rb b/rdoc-sources/FXTextField.rb index c1d25cb..d182a83 100755 --- a/rdoc-sources/FXTextField.rb +++ b/rdoc-sources/FXTextField.rb @@ -68,16 +68,16 @@ module Fox # Text [String] attr_accessor :text - # Text font [FXFont] + # Text font {FXFont} attr_accessor :font - # Text color [FXColor] + # Text color {FXColor} attr_accessor :textColor - # Background color for selected text [FXColor] + # Background color for selected text {FXColor} attr_accessor :selBackColor - # Foreground color for selected text [FXColor] + # Foreground color for selected text {FXColor} attr_accessor :selTextColor # Default width of this text field, in terms of a number of columns times the width of the numeral '8' [Integer] @@ -101,9 +101,9 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this text field [FXComposite] + # +p+:: the parent window for this text field {FXComposite} # +ncols+:: number of visible items [Integer] - # +target+:: the message target, if any, for this text field [FXObject] + # +target+:: the message target, if any, for this text field {FXObject} # +selector+:: the message identifier for this text field [Integer] # +opts+:: text field options [Integer] # +x+:: initial x-position [Integer] diff --git a/rdoc-sources/FXToggleButton.rb b/rdoc-sources/FXToggleButton.rb index 2b05b30..3399a12 100755 --- a/rdoc-sources/FXToggleButton.rb +++ b/rdoc-sources/FXToggleButton.rb @@ -27,7 +27,7 @@ module Fox # Alternate text, shown when toggled [String] attr_accessor :altText - # Alternate icon, shown when toggled [FXIcon] + # Alternate icon, shown when toggled {FXIcon} attr_accessor :altIcon # Toggled state [+true+ or +false+] @@ -47,12 +47,12 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this toggle button [FXComposite] + # +p+:: the parent window for this toggle button {FXComposite} # <tt>text1</tt>:: the text for this toggle button's first state [String] # <tt>text2</tt>:: the text for this toggle button's second state [String] - # <tt>icon1</tt>:: the icon, if any, for this toggle button's first state [FXIcon] - # <tt>icon2</tt>:: the icon, if any, for this toggle button's second state [FXIcon] - # +target+:: the message target, if any, for this toggle button [FXObject] + # <tt>icon1</tt>:: the icon, if any, for this toggle button's first state {FXIcon} + # <tt>icon2</tt>:: the icon, if any, for this toggle button's second state {FXIcon} + # +target+:: the message target, if any, for this toggle button {FXObject} # +selector+:: the message identifier for this toggle button [Integer] # +opts+:: toggle button options [Integer] # +x+:: initial x-position [Integer] diff --git a/rdoc-sources/FXToolBar.rb b/rdoc-sources/FXToolBar.rb index 0942972..1921bdc 100755 --- a/rdoc-sources/FXToolBar.rb +++ b/rdoc-sources/FXToolBar.rb @@ -18,8 +18,8 @@ module Fox # # ==== Parameters: # - # +p+:: the "dry dock" window for this tool bar [FXComposite] - # +q+:: the "wet dock" window for this tool bar [FXComposite] + # +p+:: the "dry dock" window for this tool bar {FXComposite} + # +q+:: the "wet dock" window for this tool bar {FXComposite} # +opts+:: tool bar options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] @@ -41,7 +41,7 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this tool bar [FXComposite] + # +p+:: the parent window for this tool bar {FXComposite} # +opts+:: tool bar options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] diff --git a/rdoc-sources/FXToolBarGrip.rb b/rdoc-sources/FXToolBarGrip.rb index 3171dab..db7ef57 100755 --- a/rdoc-sources/FXToolBarGrip.rb +++ b/rdoc-sources/FXToolBarGrip.rb @@ -20,7 +20,7 @@ module Fox # Indicates whether the grip is displayed as a double-bar [Boolean] attr_writer :doubleBar - # Active color [FXColor] + # Active color {FXColor} attr_accessor :activeColor # @@ -28,8 +28,8 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this tool bar grip [FXComposite] - # +target+:: the message target, if any, for this tool bar grip [FXObject] + # +p+:: the parent window for this tool bar grip {FXComposite} + # +target+:: the message target, if any, for this tool bar grip {FXObject} # +selector+:: the message identifier for this tool bar grip [Integer] # +opts+:: tool bar grip options [Integer] # +x+:: initial x-position [Integer] diff --git a/rdoc-sources/FXToolBarShell.rb b/rdoc-sources/FXToolBarShell.rb index a612f67..e59923c 100755 --- a/rdoc-sources/FXToolBarShell.rb +++ b/rdoc-sources/FXToolBarShell.rb @@ -11,16 +11,16 @@ module Fox # Border width [Integer] attr_reader :borderWidth - # Highlight color [FXColor] + # Highlight color {FXColor} attr_accessor :hiliteColor - # Shadow color [FXColor] + # Shadow color {FXColor} attr_accessor :shadowColor - # Border color [FXColor] + # Border color {FXColor} attr_accessor :borderColor - # Base GUI color [FXColor] + # Base GUI color {FXColor} attr_accessor :baseColor # @@ -28,7 +28,7 @@ module Fox # # ==== Parameters: # - # +owner+:: the owner window for this tool bar shell [FXWindow] + # +owner+:: the owner window for this tool bar shell {FXWindow} # +opts+:: tool bar shell options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] diff --git a/rdoc-sources/FXToolBarTab.rb b/rdoc-sources/FXToolBarTab.rb index 55e2e6d..7a619a7 100755 --- a/rdoc-sources/FXToolBarTab.rb +++ b/rdoc-sources/FXToolBarTab.rb @@ -35,7 +35,7 @@ module Fox # The tab style [Integer] attr_accessor :tabStyle - # The active color [FXColor] + # The active color {FXColor} attr_accessor :activeColor # Tooltip message [String] @@ -46,8 +46,8 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this toolbar tab [FXWindow] - # +target+:: the message target [FXObject] + # +p+:: the parent window for this toolbar tab {FXWindow} + # +target+:: the message target {FXObject} # +selector+:: the message identifier [Integer] # +opts+:: the options [Integer] # +x+:: x-coordinate of window upper left corner [Integer] diff --git a/rdoc-sources/FXTopWindow.rb b/rdoc-sources/FXTopWindow.rb index c8d46b7..4360380 100755 --- a/rdoc-sources/FXTopWindow.rb +++ b/rdoc-sources/FXTopWindow.rb @@ -109,10 +109,10 @@ module Fox # Title and border decorations (see above) [Integer] attr_accessor :decorations - # Window icon [FXIcon] + # Window icon {FXIcon} attr_accessor :icon - # Window mini (title) icon [FXIcon] + # Window mini (title) icon {FXIcon} attr_accessor :miniIcon # Show this window with given _placement_ diff --git a/rdoc-sources/FXTranslator.rb b/rdoc-sources/FXTranslator.rb index f654216..31b4c15 100644 --- a/rdoc-sources/FXTranslator.rb +++ b/rdoc-sources/FXTranslator.rb @@ -4,7 +4,7 @@ module Fox # class FXTranslator - # The application associated with this translator [FXApp] + # The application associated with this translator {FXApp} attr_reader :app # diff --git a/rdoc-sources/FXTreeList.rb b/rdoc-sources/FXTreeList.rb index 2cb6a9a..276fbb5 100755 --- a/rdoc-sources/FXTreeList.rb +++ b/rdoc-sources/FXTreeList.rb @@ -214,37 +214,37 @@ module Fox # Number of visible items [Integer] attr_accessor :numVisible - # First root-level item [FXTreeItem] + # First root-level item {FXTreeItem} attr_reader :firstItem - # Last root-level item [FXTreeItem] + # Last root-level item {FXTreeItem} attr_reader :lastItem - # Current item, if any [FXTreeItem] + # Current item, if any {FXTreeItem} attr_accessor :currentItem - # Anchor item, if any [FXTreeItem] + # Anchor item, if any {FXTreeItem} attr_accessor :anchorItem - # Item under the cursor, if any [FXTreeItem] + # Item under the cursor, if any {FXTreeItem} attr_reader :cursorItem - # Text font [FXFont] + # Text font {FXFont} attr_accessor :font # Parent-child indent amount, in pixels [Integer] attr_accessor :indent - # Normal text color [FXColor] + # Normal text color {FXColor} attr_accessor :textColor - # Selected text background color [FXColor] + # Selected text background color {FXColor} attr_accessor :selBackColor - # Selected text color [FXColor] + # Selected text color {FXColor} attr_accessor :selTextColor - # Line color [FXColor] + # Line color {FXColor} attr_accessor :lineColor # List style [Integer] @@ -258,8 +258,8 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this tree list [FXComposite] - # +target+:: the message target, if any, for this tree list [FXObject] + # +p+:: the parent window for this tree list {FXComposite} + # +target+:: the message target, if any, for this tree list {FXObject} # +selector+:: the message identifier for this tree list [Integer] # +opts+:: tree list options [Integer] # +x+:: initial x-position [Integer] diff --git a/rdoc-sources/FXTreeListBox.rb b/rdoc-sources/FXTreeListBox.rb index 8798898..46f5ce2 100755 --- a/rdoc-sources/FXTreeListBox.rb +++ b/rdoc-sources/FXTreeListBox.rb @@ -32,16 +32,16 @@ module Fox # Number of visible items [Integer] attr_accessor :numVisible - # First root-level item [FXTreeItem] + # First root-level item {FXTreeItem} attr_reader :firstItem - # Last root-level item [FXTreeItem] + # Last root-level item {FXTreeItem} attr_reader :lastItem - # Current item, if any [FXTreeItem] + # Current item, if any {FXTreeItem} attr_accessor :currentItem - # Text font [FXFont] + # Text font {FXFont} attr_accessor :font # Tree list box style @@ -58,8 +58,8 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this tree list box [FXComposite] - # +target+:: the message target, if any, for this tree list box [FXObject] + # +p+:: the parent window for this tree list box {FXComposite} + # +target+:: the message target, if any, for this tree list box {FXObject} # +selector+:: the message identifier for this tree list box [Integer] # +opts+:: tree list options [Integer] # +x+:: initial x-position [Integer] diff --git a/rdoc-sources/FXTriStateButton.rb b/rdoc-sources/FXTriStateButton.rb index ab5b987..c70ab82 100755 --- a/rdoc-sources/FXTriStateButton.rb +++ b/rdoc-sources/FXTriStateButton.rb @@ -10,7 +10,7 @@ module Fox # Maybe text, shown when toggled [String] attr_accessor :maybeText - # Maybe icon, shown when toggled [FXIcon] + # Maybe icon, shown when toggled {FXIcon} attr_accessor :maybeIcon # Maybe status line help text, shown when toggled [String] @@ -24,14 +24,14 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this tri-state button [FXComposite] + # +p+:: the parent window for this tri-state button {FXComposite} # <tt>text1</tt>:: the text for this tri-state button's first state [String] # <tt>text2</tt>:: the text for this tri-state button's second state [String] # <tt>text3</tt>:: the text for this tri-state button's third state [String] - # <tt>icon1</tt>:: the icon, if any, for this tri-state button's first state [FXIcon] - # <tt>icon2</tt>:: the icon, if any, for this tri-state button's second state [FXIcon] - # <tt>icon3</tt>:: the icon, if any, for this tri-state button's third state [FXIcon] - # +target+:: the message target, if any, for this tri-state button [FXObject] + # <tt>icon1</tt>:: the icon, if any, for this tri-state button's first state {FXIcon} + # <tt>icon2</tt>:: the icon, if any, for this tri-state button's second state {FXIcon} + # <tt>icon3</tt>:: the icon, if any, for this tri-state button's third state {FXIcon} + # +target+:: the message target, if any, for this tri-state button {FXObject} # +selector+:: the message identifier for this tri-state button [Integer] # +opts+:: tri-state button options [Integer] # +x+:: initial x-position [Integer] diff --git a/rdoc-sources/FXVerticalFrame.rb b/rdoc-sources/FXVerticalFrame.rb index a1c89fc..049a834 100755 --- a/rdoc-sources/FXVerticalFrame.rb +++ b/rdoc-sources/FXVerticalFrame.rb @@ -10,7 +10,7 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this vertical frame [FXComposite] + # +p+:: the parent window for this vertical frame {FXComposite} # +opts+:: frame options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] diff --git a/rdoc-sources/FXVisual.rb b/rdoc-sources/FXVisual.rb index 7b7ab40..2b3d025 100755 --- a/rdoc-sources/FXVisual.rb +++ b/rdoc-sources/FXVisual.rb @@ -11,8 +11,8 @@ module Fox # +VISUAL_GRAYSCALE+:: Gray scale visual # +VISUAL_TRUECOLOR+:: Must be true color visual # +VISUAL_OWNCOLORMAP+:: Allocate private colormap - # +VISUAL_DOUBLEBUFFER+:: Double-buffered [FXGLVisual] - # +VISUAL_STEREO+:: Stereo [FXGLVisual] + # +VISUAL_DOUBLEBUFFER+:: Double-buffered {FXGLVisual} + # +VISUAL_STEREO+:: Stereo {FXGLVisual} # +VISUAL_NOACCEL+:: No hardware acceleration [for broken h/w] # +VISUAL_SWAP_COPY+:: Buffer swap by copying (for FXGLVisual) # @@ -59,7 +59,7 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +flgs+:: visual construction flags [Integer] # +d+:: requested visual depth, in bits [Integer] # diff --git a/rdoc-sources/FXWindow.rb b/rdoc-sources/FXWindow.rb index dba6c3d..a33f2c5 100755 --- a/rdoc-sources/FXWindow.rb +++ b/rdoc-sources/FXWindow.rb @@ -152,37 +152,37 @@ module Fox class FXWindow < FXDrawable - # This window's parent window [FXWindow] + # This window's parent window {FXWindow} attr_reader :parent - # This window's owner window [FXWindow] + # This window's owner window {FXWindow} attr_reader :owner - # The shell window for this window [FXWindow] + # The shell window for this window {FXWindow} attr_reader :shell - # Root window [FXWindow] + # Root window {FXWindow} attr_reader :root - # Next (sibling) window, if any [FXWindow] + # Next (sibling) window, if any {FXWindow} attr_reader :next - # Previous (sibling) window, if any [FXWindow] + # Previous (sibling) window, if any {FXWindow} attr_reader :prev - # This window's first child window, if any [FXWindow] + # This window's first child window, if any {FXWindow} attr_reader :first - # This window's last child window, if any [FXWindow] + # This window's last child window, if any {FXWindow} attr_reader :last - # Currently focused child window, if any [FXWindow] + # Currently focused child window, if any {FXWindow} attr_reader :focus # Window key [Integer] attr_accessor :key - # Message target object for this window [FXObject] + # Message target object for this window {FXObject} attr_accessor :target # Message identifier for this window [Integer] @@ -194,7 +194,7 @@ module Fox # This window's y-coordinate, in the parent's coordinate system [Integer] attr_accessor :y - # The accelerator table for this window [FXAccelTable] + # The accelerator table for this window {FXAccelTable} attr_accessor :accelTable # Layout hints for this window [Integer] @@ -203,13 +203,13 @@ module Fox # Number of child windows for this window [Integer] attr_reader :numChildren - # Default cursor for this window [FXCursor] + # Default cursor for this window {FXCursor} attr_accessor :defaultCursor - # Drag cursor for this window [FXCursor] + # Drag cursor for this window {FXCursor} attr_accessor :dragCursor - # Window background color [FXColor] + # Window background color {FXColor} attr_accessor :backColor # Common DND type: Raw octet stream @@ -265,7 +265,7 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this window [FXComposite] + # +p+:: the parent window for this window {FXComposite} # +opts+:: window options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] @@ -280,8 +280,8 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +vis+:: the visual to use for this window [FXVisual] + # +a+:: an application instance {FXApp} + # +vis+:: the visual to use for this window {FXVisual} # def initialize(a, vis) # :yields: theWindow end @@ -291,8 +291,8 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +own+:: the owner window for this window [FXWindow] + # +a+:: an application instance {FXApp} + # +own+:: the owner window for this window {FXWindow} # +opts+:: window options [Integer] # +x+:: initial x-position [Integer] # +y+:: initial y-position [Integer] diff --git a/rdoc-sources/FXWizard.rb b/rdoc-sources/FXWizard.rb index 4d8c6ca..9e840c0 100755 --- a/rdoc-sources/FXWizard.rb +++ b/rdoc-sources/FXWizard.rb @@ -13,25 +13,25 @@ module Fox # class FXWizard < FXDialogBox - # The button frame [FXHorizontalFrame] + # The button frame {FXHorizontalFrame} attr_reader :buttonFrame - # The "Advance" button [FXButton] + # The "Advance" button {FXButton} attr_reader :advanceButton - # The "Retreat" button [FXButton] + # The "Retreat" button {FXButton} attr_reader :retreatButton - # The "Finish" button [FXButton] + # The "Finish" button {FXButton} attr_reader :finishButton - # The "Cancel" button [FXButton] + # The "Cancel" button {FXButton} attr_reader :cancelButton - # The container used as parent for the sub-panels [FXSwitcher] + # The container used as parent for the sub-panels {FXSwitcher} attr_reader :container - # The image being displayed [FXImage] + # The image being displayed {FXImage} attr_accessor :image # diff --git a/rdoc-sources/FXXBMIcon.rb b/rdoc-sources/FXXBMIcon.rb index d6c4040..f5d1c1e 100755 --- a/rdoc-sources/FXXBMIcon.rb +++ b/rdoc-sources/FXXBMIcon.rb @@ -18,10 +18,10 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pixels+:: a memory buffer formatted in XBM file format [String] # +mask+:: a memory buffer formatted in XBM file format [String] - # +clr+:: transparency color [FXColor] + # +clr+:: transparency color {FXColor} # +opts+:: options [Integer] # +width+:: width [Integer] # +height+:: height [Integer] diff --git a/rdoc-sources/FXXBMImage.rb b/rdoc-sources/FXXBMImage.rb index 100ba8e..d2252c0 100755 --- a/rdoc-sources/FXXBMImage.rb +++ b/rdoc-sources/FXXBMImage.rb @@ -18,7 +18,7 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pixels+:: a memory buffer formatted in XBM file format [String] # +mask+:: a memory buffer formatted in XBM file format [String] # +opts+:: options [Integer] diff --git a/rdoc-sources/FXXPMIcon.rb b/rdoc-sources/FXXPMIcon.rb index 6079c38..0c1cec1 100755 --- a/rdoc-sources/FXXPMIcon.rb +++ b/rdoc-sources/FXXPMIcon.rb @@ -18,9 +18,9 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in XPM file format [String] - # +clr+:: transparency color [FXColor] + # +clr+:: transparency color {FXColor} # +opts+:: options [Integer] # +width+:: width [Integer] # +height+:: height [Integer] @@ -38,7 +38,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data {FXStream} # def Fox.fxloadXPM(store); end @@ -48,9 +48,9 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the file data [FXStream] + # +store+:: stream to which to write the file data {FXStream} # +data+:: the image pixel data, an array of FXColor values - # +transp+:: transparency color [FXColor] + # +transp+:: transparency color {FXColor} # +width+:: width [Integer] # +height+:: height [Integer] # +fast+:: if +true+, use fast something diff --git a/rdoc-sources/FXXPMImage.rb b/rdoc-sources/FXXPMImage.rb index 40fab42..73dc40c 100755 --- a/rdoc-sources/FXXPMImage.rb +++ b/rdoc-sources/FXXPMImage.rb @@ -18,7 +18,7 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] + # +a+:: an application instance {FXApp} # +pix+:: a memory buffer formatted in XPM file format [String] # +opts+:: options [Integer] # +width+:: width [Integer] -- GitLab