Docs: Documentation updates for LazUtils. Issue #37965, patch from Don Siders.

git-svn-id: trunk@64052 -
This commit is contained in:
juha 2020-10-22 15:34:19 +00:00
parent 4aef0be3b0
commit 2f04fb505a
4 changed files with 2841 additions and 209 deletions

2
.gitattributes vendored
View File

@ -6072,7 +6072,7 @@ docs/xml/lazutils/dynamicarray.xml svneol=native#text/plain
docs/xml/lazutils/dynhasharray.xml svneol=native#text/plain
docs/xml/lazutils/dynqueue.xml svneol=native#text/plain
docs/xml/lazutils/extendedstrings.xml svneol=native#text/plain
docs/xml/lazutils/filereferencelist.xml -text svneol=native#text/plain
docs/xml/lazutils/filereferencelist.xml svneol=native#text/plain
docs/xml/lazutils/fileutil.xml svneol=native#text/plain
docs/xml/lazutils/fpcadds.xml svneol=LF#text/xml eol=lf
docs/xml/lazutils/fpmake.xml svneol=native#text/plain

View File

@ -1,199 +1,199 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
<!--
====================================================================
FileReferenceList
====================================================================
-->
<module name="FileReferenceList">
<short>Contains types and classes used to implement a list of file references</short>
<descr>
<p>
Implements the TFileReference and TFileReferenceList classes. Provides a list of file references with counters and a search path for all files.
</p>
<p>
Author: Mattias Gaertner
</p>
</descr>
<!-- unresolved external references -->
<element id="Classes"/>
<element id="SysUtils"/>
<element id="Laz_AVL_Tree"/>
<element id="LazFileUtils"/>
<element id="LazFileCache"/>
<element id="LazTracer"/>
<element name="TFileReference">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReference.fFilename"/>
<element name="TFileReference.fReferenceCount"/>
<element name="TFileReference.Filename">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReference.ReferenceCount">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceFlag">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceFlag.frfSearchPathValid">
<short/>
</element>
<element name="TFileReferenceFlag.frfChanged">
<short/>
</element>
<element name="TFileReferenceFlags">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.FOnChanged"/>
<element name="TFileReferenceList.FTimeStamp"/>
<element name="TFileReferenceList.FTree">
<short>Tree of TFileReference instances sorted by file name</short>
</element>
<element name="TFileReferenceList.FFlags"/>
<element name="TFileReferenceList.FSearchPath"/>
<element name="TFileReferenceList.FUpdateLock"/>
<element name="TFileReferenceList.UpdateSearchPath">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.IncreaseTimeStamp">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.Invalidate">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.Create">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.Destroy">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.Clear">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.BeginUpdate">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.EndUpdate">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.AddFilename">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.AddFilename.Filename">
<short/>
</element>
<element name="TFileReferenceList.RemoveFilename">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.RemoveFilename.Filename">
<short/>
</element>
<element name="TFileReferenceList.GetFileReference">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.GetFileReference.Result">
<short/>
</element>
<element name="TFileReferenceList.GetFileReference.Filename">
<short/>
</element>
<element name="TFileReferenceList.CreateSearchPathFromAllFiles">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.CreateSearchPathFromAllFiles.Result">
<short/>
</element>
<element name="TFileReferenceList.CreateFileList">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.CreateFileList.Result">
<short/>
</element>
<element name="TFileReferenceList.TimeStamp">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.OnChanged">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.UpdateLock">
<short/>
<descr/>
<seealso/>
</element>
</module>
<!-- FileReferenceList -->
</package>
</fpdoc-descriptions>
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
<!--
====================================================================
FileReferenceList
====================================================================
-->
<module name="FileReferenceList">
<short>Contains types and classes used to implement a list of file references</short>
<descr>
<p>
Implements the TFileReference and TFileReferenceList classes. Provides a list of file references with counters and a search path for all files.
</p>
<p>
Author: Mattias Gaertner
</p>
</descr>
<!-- unresolved external references -->
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Laz_AVL_Tree"/>
<element name="LazFileUtils"/>
<element name="LazFileCache"/>
<element name="LazTracer"/>
<element name="TFileReference">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReference.fFilename"/>
<element name="TFileReference.fReferenceCount"/>
<element name="TFileReference.Filename">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReference.ReferenceCount">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceFlag">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceFlag.frfSearchPathValid">
<short/>
</element>
<element name="TFileReferenceFlag.frfChanged">
<short/>
</element>
<element name="TFileReferenceFlags">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.FOnChanged"/>
<element name="TFileReferenceList.FTimeStamp"/>
<element name="TFileReferenceList.FTree">
<short>Tree of TFileReference instances sorted by file name</short>
</element>
<element name="TFileReferenceList.FFlags"/>
<element name="TFileReferenceList.FSearchPath"/>
<element name="TFileReferenceList.FUpdateLock"/>
<element name="TFileReferenceList.UpdateSearchPath">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.IncreaseTimeStamp">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.Invalidate">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.Create">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.Destroy">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.Clear">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.BeginUpdate">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.EndUpdate">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.AddFilename">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.AddFilename.Filename">
<short/>
</element>
<element name="TFileReferenceList.RemoveFilename">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.RemoveFilename.Filename">
<short/>
</element>
<element name="TFileReferenceList.GetFileReference">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.GetFileReference.Result">
<short/>
</element>
<element name="TFileReferenceList.GetFileReference.Filename">
<short/>
</element>
<element name="TFileReferenceList.CreateSearchPathFromAllFiles">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.CreateSearchPathFromAllFiles.Result">
<short/>
</element>
<element name="TFileReferenceList.CreateFileList">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.CreateFileList.Result">
<short/>
</element>
<element name="TFileReferenceList.TimeStamp">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.OnChanged">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.UpdateLock">
<short/>
<descr/>
<seealso/>
</element>
</module>
<!-- FileReferenceList -->
</package>
</fpdoc-descriptions>

File diff suppressed because it is too large Load Diff

View File

@ -1,4 +1,4 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
@ -14,11 +14,11 @@
</descr>
<!-- unresolved externals -->
<element id="Classes"/>
<element id="SysUtils"/>
<element id="FileUtil"/>
<element id="Types"/>
<element id="LazClasses"/>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="FileUtil"/>
<element name="Types"/>
<element name="LazClasses"/>
<!-- enumeration type Visibility: default -->
<element name="TLazLoggerLogGroupFlag">