From 860295db980257a08f95785733dbf23447840614 Mon Sep 17 00:00:00 2001
From: kirkpatc <kirkpatc@lazarus-ide.org>
Date: Tue, 6 May 2008 16:28:51 +0000
Subject: [PATCH] Description added for TDirSelDlg in dirsel.xml; links added
 in dialogs.xml and editbtn.xml

git-svn-id: trunk@15062 -
---
 docs/xml/lcl/dialogs.xml |   4 +-
 docs/xml/lcl/dirsel.xml  | 743 +++++++++++++++++----------------------
 docs/xml/lcl/editbtn.xml |   5 +-
 3 files changed, 327 insertions(+), 425 deletions(-)

diff --git a/docs/xml/lcl/dialogs.xml b/docs/xml/lcl/dialogs.xml
index 4c40fe483f..be5907ef31 100644
--- a/docs/xml/lcl/dialogs.xml
+++ b/docs/xml/lcl/dialogs.xml
@@ -1005,7 +1005,9 @@ if no file is specified, the Save File As dialog is invoked and the buffer is sa
         <short>Select Directory Dialog</short>
         <descr>Select Directory Dialog: allows the user to select a directory when the directory structure is displayed as a tree.</descr>
         <errors/>
-        <seealso/>
+	<seealso><link id="#lcl.dirsel.tdirseldlg">TDirSelDlg</link>
+		<link id="#lcl.editbtn.tdirectoryedit">TDirectoryEdit</link>
+	</seealso>
       </element>
       <!-- function Visibility: protected -->
       <element name="TSelectDirectoryDialog.CheckFileMustExist">
diff --git a/docs/xml/lcl/dirsel.xml b/docs/xml/lcl/dirsel.xml
index 64e51f55c6..744d39dddd 100644
--- a/docs/xml/lcl/dirsel.xml
+++ b/docs/xml/lcl/dirsel.xml
@@ -1,430 +1,327 @@
-<?xml version="1.0" encoding="ISO8859-1"?>
+<?xml version="1.0"?>
 <fpdoc-descriptions>
-<package name="lcl">
-
-<!--
+  <package name="lcl">
+    <!--
   ====================================================================
     DirSel
   ====================================================================
 -->
-
-<module name="DirSel">
-<short></short>
-<descr>
+    <module name="DirSel">
+      <short>A dialog for displaying a directory structure and selecting a directory</short>
+      <descr/>
+      <seealso><link id="#lcl.editbtn.tdirectoryedit">TDirectoryEdit</link>
+	      <link id="#lcl.dialogs.tselectdirectorydialog">TSelectDirectoryDialog</link>
+      </seealso>
+      <!-- unresolved type reference Visibility: default -->
+      <element name="Classes">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- unresolved type reference Visibility: default -->
+      <element name="SysUtils">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- unresolved type reference Visibility: default -->
+      <element name="LResources">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- unresolved type reference Visibility: default -->
+      <element name="Forms">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- unresolved type reference Visibility: default -->
+      <element name="Controls">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- unresolved type reference Visibility: default -->
+      <element name="Graphics">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- unresolved type reference Visibility: default -->
+      <element name="Dialogs">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- unresolved type reference Visibility: default -->
+      <element name="Buttons">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- unresolved type reference Visibility: default -->
+      <element name="StdCtrls">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- unresolved type reference Visibility: default -->
+      <element name="ComCtrls">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- unresolved type reference Visibility: default -->
+      <element name="ExtCtrls">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- unresolved type reference Visibility: default -->
+      <element name="FileCtrl">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- object Visibility: default -->
+      <element name="TDirSelDlg">
+        <short>
+          <var>TDirSelDlg</var> - a dialog for selecting a directory from a TreeView list</short>
+        <descr/>
+        <errors/>
+        <seealso/>
+      </element>
+      <!-- variable Visibility: default -->
+      <element name="TDirSelDlg.Button1">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- variable Visibility: default -->
+      <element name="TDirSelDlg.Button2">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- variable Visibility: default -->
+      <element name="TDirSelDlg.Label1">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- variable Visibility: default -->
+      <element name="TDirSelDlg.Panel1">
+        <short>
+          <var>Panel1</var> - the panel in which the control buttons are displayed</short>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- variable Visibility: default -->
+      <element name="TDirSelDlg.Panel2">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- variable Visibility: default -->
+      <element name="TDirSelDlg.Panel3">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- variable Visibility: default -->
+      <element name="TDirSelDlg.Panel4">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- variable Visibility: default -->
+      <element name="TDirSelDlg.TV">
+        <short>
+          <var>TV</var> - the Tree View that shows the directory structure</short>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- procedure Visibility: default -->
+      <element name="TDirSelDlg.FormCreate">
+        <short/>
+        <descr/>
+        <errors/>
+        <seealso/>
+      </element>
+      <!-- argument Visibility: default -->
+      <element name="TDirSelDlg.FormCreate.Sender">
+        <short/>
+      </element>
+      <!-- procedure Visibility: default -->
+      <element name="TDirSelDlg.FormShow">
+        <short>
+          <var>FormShow</var> - method for displaying the created form</short>
+        <descr/>
+        <errors/>
+        <seealso/>
+      </element>
+      <!-- argument Visibility: default -->
+      <element name="TDirSelDlg.FormShow.Sender">
+        <short/>
+      </element>
+      <!-- procedure Visibility: default -->
+      <element name="TDirSelDlg.TVExpanded">
+        <short>
+          <var>TVExpanded</var> - method for expanding the Tree View for the directory structure</short>
+        <descr/>
+        <errors/>
+        <seealso/>
+      </element>
+      <!-- argument Visibility: default -->
+      <element name="TDirSelDlg.TVExpanded.Sender">
+        <short/>
+      </element>
+      <!-- argument Visibility: default -->
+      <element name="TDirSelDlg.TVExpanded.Node">
+        <short/>
+      </element>
+      <!-- procedure Visibility: default -->
+      <element name="TDirSelDlg.TVItemDoubleClick">
+        <short/>
+        <descr/>
+        <errors/>
+        <seealso/>
+      </element>
+      <!-- argument Visibility: default -->
+      <element name="TDirSelDlg.TVItemDoubleClick.Sender">
+        <short/>
+      </element>
+      <!-- variable Visibility: private -->
+      <element name="TDirSelDlg.FRootDir">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- variable Visibility: private -->
+      <element name="TDirSelDlg.FDir">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- variable Visibility: private -->
+      <element name="TDirSelDlg.FShowHidden">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- procedure Visibility: private -->
+      <element name="TDirSelDlg.AddDirectories">
+        <short/>
+        <descr/>
+        <errors/>
+        <seealso/>
+      </element>
+      <!-- argument Visibility: default -->
+      <element name="TDirSelDlg.AddDirectories.Node">
+        <short/>
+      </element>
+      <!-- argument Visibility: default -->
+      <element name="TDirSelDlg.AddDirectories.Dir">
+        <short/>
+      </element>
+      <!-- function Visibility: private -->
+      <element name="TDirSelDlg.GetAbsolutePath">
+        <short/>
+        <descr/>
+        <errors/>
+        <seealso/>
+      </element>
+      <!-- function result Visibility: default -->
+      <element name="TDirSelDlg.GetAbsolutePath.Result">
+        <short/>
+      </element>
+      <!-- argument Visibility: default -->
+      <element name="TDirSelDlg.GetAbsolutePath.Node">
+        <short/>
+      </element>
+      <!-- procedure Visibility: private -->
+      <element name="TDirSelDlg.SetDir">
+        <short/>
+        <descr/>
+        <errors/>
+        <seealso/>
+      </element>
+      <!-- argument Visibility: default -->
+      <element name="TDirSelDlg.SetDir.Value">
+        <short/>
+      </element>
+      <!-- procedure Visibility: private -->
+      <element name="TDirSelDlg.SetRootDir">
+        <short/>
+        <descr/>
+        <errors/>
+        <seealso/>
+      </element>
+      <!-- argument Visibility: default -->
+      <element name="TDirSelDlg.SetRootDir.Value">
+        <short/>
+      </element>
+      <!-- function Visibility: public -->
+      <element name="TDirSelDlg.SelectedDir">
+        <short>
+          <var>SelectedDir</var> - returns the name of the selected directory as a string</short>
+        <descr/>
+        <errors/>
+        <seealso/>
+      </element>
+      <!-- function result Visibility: default -->
+      <element name="TDirSelDlg.SelectedDir.Result">
+        <short/>
+      </element>
+      <!-- property Visibility: public -->
+      <element name="TDirSelDlg.Directory">
+        <short>
+          <var>Directory</var> - the currently selected directory: either the value inserted at the start, or the value selected from the Tree View</short>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- property Visibility: public -->
+      <element name="TDirSelDlg.RootDirectory">
+        <short>
+          <var>RootDirectory</var> - the root directory from which the tree structure is derived</short>
+        <descr/>
+        <seealso/>
+      </element>
+      <!-- property Visibility: public -->
+      <element name="TDirSelDlg.ShowHidden">
+        <short>
+          <var>ShowHidden</var> - if True, display the names of hidden directories</short>
+        <descr>
+          <p>
+            <var>ShowHidden</var> - if True, display the names of hidden directories</p>
+For example, in Windows and derivatives, display directories in and below the 'Windows' directory (mostly system files); in Unix/Linux etc, display directories prefixed with a dot (mostly configuration files, eg ' .lazarus ')
 </descr>
-
-<!-- unresolved type reference Visibility: default -->
-<element name="Classes">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- unresolved type reference Visibility: default -->
-<element name="SysUtils">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- unresolved type reference Visibility: default -->
-<element name="LResources">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- unresolved type reference Visibility: default -->
-<element name="Forms">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- unresolved type reference Visibility: default -->
-<element name="Controls">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- unresolved type reference Visibility: default -->
-<element name="Graphics">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- unresolved type reference Visibility: default -->
-<element name="Dialogs">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- unresolved type reference Visibility: default -->
-<element name="Buttons">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- unresolved type reference Visibility: default -->
-<element name="StdCtrls">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- unresolved type reference Visibility: default -->
-<element name="ComCtrls">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- unresolved type reference Visibility: default -->
-<element name="ExtCtrls">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- unresolved type reference Visibility: default -->
-<element name="FileCtrl">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- object Visibility: default -->
-<element name="TDirSelDlg">
-<short></short>
-<descr>
-</descr>
-<errors>
-</errors>
-<seealso>
-</seealso>
-</element>
-
-<!-- variable Visibility: default -->
-<element name="TDirSelDlg.Button1">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- variable Visibility: default -->
-<element name="TDirSelDlg.Button2">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- variable Visibility: default -->
-<element name="TDirSelDlg.Label1">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- variable Visibility: default -->
-<element name="TDirSelDlg.Panel1">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- variable Visibility: default -->
-<element name="TDirSelDlg.Panel2">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- variable Visibility: default -->
-<element name="TDirSelDlg.Panel3">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- variable Visibility: default -->
-<element name="TDirSelDlg.Panel4">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- variable Visibility: default -->
-<element name="TDirSelDlg.TV">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- procedure Visibility: default -->
-<element name="TDirSelDlg.FormCreate">
-<short></short>
-<descr>
-</descr>
-<errors>
-</errors>
-<seealso>
-</seealso>
-</element>
-
-<!-- argument Visibility: default -->
-<element name="TDirSelDlg.FormCreate.Sender">
-<short></short>
-</element>
-
-<!-- procedure Visibility: default -->
-<element name="TDirSelDlg.FormShow">
-<short></short>
-<descr>
-</descr>
-<errors>
-</errors>
-<seealso>
-</seealso>
-</element>
-
-<!-- argument Visibility: default -->
-<element name="TDirSelDlg.FormShow.Sender">
-<short></short>
-</element>
-
-<!-- procedure Visibility: default -->
-<element name="TDirSelDlg.TVExpanded">
-<short></short>
-<descr>
-</descr>
-<errors>
-</errors>
-<seealso>
-</seealso>
-</element>
-
-<!-- argument Visibility: default -->
-<element name="TDirSelDlg.TVExpanded.Sender">
-<short></short>
-</element>
-
-<!-- argument Visibility: default -->
-<element name="TDirSelDlg.TVExpanded.Node">
-<short></short>
-</element>
-
-<!-- procedure Visibility: default -->
-<element name="TDirSelDlg.TVItemDoubleClick">
-<short></short>
-<descr>
-</descr>
-<errors>
-</errors>
-<seealso>
-</seealso>
-</element>
-
-<!-- argument Visibility: default -->
-<element name="TDirSelDlg.TVItemDoubleClick.Sender">
-<short></short>
-</element>
-
-<!-- variable Visibility: private -->
-<element name="TDirSelDlg.FRootDir">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- variable Visibility: private -->
-<element name="TDirSelDlg.FDir">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- variable Visibility: private -->
-<element name="TDirSelDlg.FShowHidden">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- procedure Visibility: private -->
-<element name="TDirSelDlg.AddDirectories">
-<short></short>
-<descr>
-</descr>
-<errors>
-</errors>
-<seealso>
-</seealso>
-</element>
-
-<!-- argument Visibility: default -->
-<element name="TDirSelDlg.AddDirectories.Node">
-<short></short>
-</element>
-
-<!-- argument Visibility: default -->
-<element name="TDirSelDlg.AddDirectories.Dir">
-<short></short>
-</element>
-
-<!-- function Visibility: private -->
-<element name="TDirSelDlg.GetAbsolutePath">
-<short></short>
-<descr>
-</descr>
-<errors>
-</errors>
-<seealso>
-</seealso>
-</element>
-
-<!-- function result Visibility: default -->
-<element name="TDirSelDlg.GetAbsolutePath.Result">
-<short></short>
-</element>
-
-<!-- argument Visibility: default -->
-<element name="TDirSelDlg.GetAbsolutePath.Node">
-<short></short>
-</element>
-
-<!-- procedure Visibility: private -->
-<element name="TDirSelDlg.SetDir">
-<short></short>
-<descr>
-</descr>
-<errors>
-</errors>
-<seealso>
-</seealso>
-</element>
-
-<!-- argument Visibility: default -->
-<element name="TDirSelDlg.SetDir.Value">
-<short></short>
-</element>
-
-<!-- procedure Visibility: private -->
-<element name="TDirSelDlg.SetRootDir">
-<short></short>
-<descr>
-</descr>
-<errors>
-</errors>
-<seealso>
-</seealso>
-</element>
-
-<!-- argument Visibility: default -->
-<element name="TDirSelDlg.SetRootDir.Value">
-<short></short>
-</element>
-
-<!-- function Visibility: public -->
-<element name="TDirSelDlg.SelectedDir">
-<short></short>
-<descr>
-</descr>
-<errors>
-</errors>
-<seealso>
-</seealso>
-</element>
-
-<!-- function result Visibility: default -->
-<element name="TDirSelDlg.SelectedDir.Result">
-<short></short>
-</element>
-
-<!-- property Visibility: public -->
-<element name="TDirSelDlg.Directory">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- property Visibility: public -->
-<element name="TDirSelDlg.RootDirectory">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- property Visibility: public -->
-<element name="TDirSelDlg.ShowHidden">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-
-<!-- variable Visibility: default -->
-<element name="DirSelDlg">
-<short></short>
-<descr>
-</descr>
-<seealso>
-</seealso>
-</element>
-</module> <!-- DirSel -->
-</package>
+        <seealso/>
+      </element>
+      <!-- variable Visibility: default -->
+      <element name="DirSelDlg">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+      <element name="TDirSelDlg.btnOK">
+        <short>
+          <var>btnOK</var> - the 'OK' button for accepting a directory name (suggest the user changes the caption to 'OK')</short>
+      </element>
+      <element name="TDirSelDlg.btnCancel">
+        <short>
+          <var>btnCancel</var> - the 'Cancel' button if no selection is desired (suggest the user changes caption to 'Cancel')</short>
+      </element>
+      <element name="TDirSelDlg.lblDirectory">
+        <short>
+          <var>lblDirectory</var> - the label above the panel indicating that the directory is being displayed</short>
+      </element>
+      <element name="TDirSelDlg.DirectoryPanel">
+        <short>
+          <var>DirectoryPanel</var> - the panel in which the directory structure is displayed</short>
+      </element>
+    </module>
+    <!-- DirSel -->
+  </package>
 </fpdoc-descriptions>
diff --git a/docs/xml/lcl/editbtn.xml b/docs/xml/lcl/editbtn.xml
index 6456412bc4..cd89fa93e2 100644
--- a/docs/xml/lcl/editbtn.xml
+++ b/docs/xml/lcl/editbtn.xml
@@ -1228,7 +1228,10 @@
           <var>TDirectoryEdit</var> - an EditBox to hold a directory name, with an attached SpeedButton that will summon a Directory Open dialog</short>
         <descr/>
         <errors/>
-        <seealso/>
+        <seealso>
+		<link id="#lcl.dirsel.tdirseldlg">Directory Select Dialog</link>
+		<link id="#lcl.dialogs.tselectdirectorydialog">TSelectDirectoryDialog</link>
+	</seealso>
       </element>
       <!-- variable Visibility: private -->
       <element name="TDirectoryEdit.FDialogTitle">