From 428d8f07989885c5d7314ac4e82c869e0bc23459 Mon Sep 17 00:00:00 2001
From: Graeme Geldenhuys <graeme@mastermaths.co.za>
Date: Tue, 4 Dec 2012 17:00:06 +0000
Subject: fpgui documentation updates.

---
 docs/xml/corelib/fpg_base.xml  |  4 ++++
 docs/xml/gui/fpg_button.xml    |  6 +++---
 docs/xml/gui/fpg_form.xml      | 12 ++++++------
 docs/xml/gui/fpg_hyperlink.xml |  4 ++--
 docs/xml/gui/fpg_tree.xml      | 12 ++++++------
 5 files changed, 21 insertions(+), 17 deletions(-)

(limited to 'docs/xml')

diff --git a/docs/xml/corelib/fpg_base.xml b/docs/xml/corelib/fpg_base.xml
index aeaddc44..abcb6f53 100644
--- a/docs/xml/corelib/fpg_base.xml
+++ b/docs/xml/corelib/fpg_base.xml
@@ -824,6 +824,10 @@ Gaussian, Sinc etc... These decendant filters are used in the
           <printshort id="TfpgCanvasbase.DrawLine"/>. This method draws a line from (x1,y1) to (x2,y2), but does not draw the last pixel. All supported backends follow the Microsoft API and doesn't draw the last pixel. This optimises consecutive lines being drawn without overlapping pixels.</descr>
       </element>
 
+<element name="TfpgCanvasBase.StretchDraw">
+<short>Allows you to draw a bitmap, stretched or shrunken from its original size</short>
+</element>
+
       <!-- function Visibility: default -->
       <element name="KeycodeToText">
         <short>Returns the text representation of a keycode.</short>
diff --git a/docs/xml/gui/fpg_button.xml b/docs/xml/gui/fpg_button.xml
index 38da104f..0d0a13ce 100644
--- a/docs/xml/gui/fpg_button.xml
+++ b/docs/xml/gui/fpg_button.xml
@@ -48,9 +48,9 @@ simply publishes various properties for runtime type information.</descr>
         </seealso>
       </element>
 
-<element name="TfpgButton.ImageName" link="TfpgBaseButton.ImageName"/>
-<element name="TfpgButton.ImageSpacing" link="TfpgBaseButton.ImageSpacing"/>
-<element name="TfpgButton.ImageLayout" link="TfpgBaseButton.ImageLayout"/>
+<element name="TfpgButton.ImageName" link="#fpgui.fpg_button.TfpgBaseButton.ImageName"/>
+<element name="TfpgButton.ImageSpacing" link="#fpgui.fpg_button.TfpgBaseButton.ImageSpacing"/>
+<element name="TfpgButton.ImageLayout" link="#fpgui.fpg_button.TfpgBaseButton.ImageLayout"/>
 
 
     </module>
diff --git a/docs/xml/gui/fpg_form.xml b/docs/xml/gui/fpg_form.xml
index 3dfb01fc..7bfdf975 100644
--- a/docs/xml/gui/fpg_form.xml
+++ b/docs/xml/gui/fpg_form.xml
@@ -3,26 +3,26 @@
   <package name="fpGUI">
     <module name="fpg_form">
       <short>This unit contains the class implementation representing a Form/Window on the screen</short>
-      <descr/>
+	  <descr><printshort id="fpg_form"/>.</descr>
 
 <element name="TWindowPosition.wpUser">
-<descr>OS or Desktop/Window manager decides the position.</descr>
+<short>OS or Desktop/Window manager decides the position.</short>
 </element>
 
 <element name="TWindowPosition.wpAuto">
-<descr>Window gets placed in exact x,y coordinates set by developer.</descr>
+<short>Window gets placed in exact x,y coordinates set by developer.</short>
 </element>
 
 <element name="TWindowPosition.wpScreenCenter">
-<descr>Window gets centered horizontally and vertically in the current desktop window.</descr>
+<short>Window gets centered horizontally and vertically in the current desktop window.</short>
 </element>
 
 <element name="TWindowPosition.wpOneThirdDown">
-<descr>Following the "golden ratio 1.618" rules or ideas as to what is
+<short>Following the "golden ratio 1.618" rules or ideas as to what is
 pleasing to the eye. The window is positioned one third from
 the top of the screen, using the desktop height to calculate, and centered
 horizontally.
-</descr>
+</short>
 </element>
 
     </module>
diff --git a/docs/xml/gui/fpg_hyperlink.xml b/docs/xml/gui/fpg_hyperlink.xml
index 0c3d507c..ae59a8a9 100644
--- a/docs/xml/gui/fpg_hyperlink.xml
+++ b/docs/xml/gui/fpg_hyperlink.xml
@@ -3,9 +3,9 @@
   <package name="fpGUI">
     <module name="fpg_hyperlink">
       <short>A label component that can launch a web browser</short>
-      <descr><p>This component acts like a link found in a web page. You can assign a
+	  <descr><printshort id="fpg_hyperlink"/>. This component acts like a link found in a web page. You can assign a
 target URL and if the user clicks on the component, it will launch a web browser
-using the target URL as destination.</p></descr>
+using the target URL as destination.</descr>
       <element name="TfpgHyperlink">
         <short>A <var>TfpgCustomLabel</var> descendant that implements hyperlink support</short>
         <descr>This is a class to implement a hyperlink. Of course, such as all 
diff --git a/docs/xml/gui/fpg_tree.xml b/docs/xml/gui/fpg_tree.xml
index 13ba18b0..54cbd893 100644
--- a/docs/xml/gui/fpg_tree.xml
+++ b/docs/xml/gui/fpg_tree.xml
@@ -147,12 +147,12 @@ and attribute all in one. A font alias is in the format <var>#aliasname</var>.</
 </element>
 
 
-<element name="TfpgTreeview.HandleLMouseUp" link="fpg_widget.TfpgWidget.HandleLMouseUp"/>
-<element name="TfpgTreeview.HandleLMouseDown" link="fpg_widget.TfpgWidget.HandleLMouseDown"/>
-<element name="TfpgTreeview.HandleRMouseUp" link="fpg_widget.TfpgWidget.HandleRMouseUp"/>
-<element name="TfpgTreeview.HandleDoubleClick" link="fpg_widget.TfpgWidget.HandleDoubleClick"/>
-<element name="TfpgTreeview.HandleKeyPress" link="fpg_widget.TfpgWidget.HandleKeyPress"/>
-<element name="TfpgTreeview.HandleMouseScroll" link="fpg_widget.TfpgWidget.HandleMouseScroll"/>
+<element name="TfpgTreeview.HandleLMouseUp" link="#fpgui.fpg_widget.TfpgWidget.HandleLMouseUp"/>
+<element name="TfpgTreeview.HandleLMouseDown" link="#fpgui.fpg_widget.TfpgWidget.HandleLMouseDown"/>
+<element name="TfpgTreeview.HandleRMouseUp" link="#fpgui.fpg_widget.TfpgWidget.HandleRMouseUp"/>
+<element name="TfpgTreeview.HandleDoubleClick" link="#fpgui.fpg_widget.TfpgWidget.HandleDoubleClick"/>
+<element name="TfpgTreeview.HandleKeyPress" link="#fpgui.fpg_widget.TfpgWidget.HandleKeyPress"/>
+<element name="TfpgTreeview.HandleMouseScroll" link="#fpgui.fpg_widget.TfpgWidget.HandleMouseScroll"/>
 
 
 </module>
-- 
cgit v1.2.3-70-g09d2