mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-04-14 03:19:32 +02:00
lazutils: docs: updates from Don Siders, issue #35908
git-svn-id: trunk@61656 -
This commit is contained in:
mattias
parent
e3ee510e52
commit
88570a4d4e
File diff suppressed because it is too large
Load Diff
@ -7,8 +7,13 @@
|
||||
====================================================================
|
||||
-->
|
||||
<module name="lazutf8sysutils">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<short>Unit renamed to LazSysUtils</short>
|
||||
<descr>
|
||||
<p>
|
||||
lazutf8sysutils.pas was renamed to lazsysutils.pas.
|
||||
All routines will give a "deprecated" warning; the unit will be removed later.
|
||||
</p>
|
||||
</descr>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="NowUTC">
|
||||
@ -17,7 +22,7 @@
|
||||
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="NowUTC.Result">
|
||||
<short></short>
|
||||
<short>Current Date/Time value in UTC</short>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
@ -27,7 +32,7 @@
|
||||
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="GetTickCount64.Result">
|
||||
<short></short>
|
||||
<short>Number of ticks (milliseconds)</short>
|
||||
</element>
|
||||
|
||||
</module>
|
||||
|
||||
@ -1,169 +1,83 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<fpdoc-descriptions>
|
||||
<package name="lazutils">
|
||||
<package name="lazutils">
|
||||
<!--
|
||||
====================================================================
|
||||
LazUtilities
|
||||
====================================================================
|
||||
-->
|
||||
<module name="LazUtilities">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
|
||||
<!--
|
||||
====================================================================
|
||||
LazUtilities
|
||||
====================================================================
|
||||
-->
|
||||
<element name="FreeThenNil">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="FreeThenNil.obj">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<module name="LazUtilities">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<!-- function Visibility: default -->
|
||||
<element name="ComparePointers">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="ComparePointers">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="ComparePointers.Result">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="ComparePointers.Result">
|
||||
<short></short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="ComparePointers.p1">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="ComparePointers.p1">
|
||||
<short></short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="ComparePointers.p2">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="ComparePointers.p2">
|
||||
<short></short>
|
||||
</element>
|
||||
<element name="CompareBoolean">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="CompareBoolean.Result">
|
||||
<short></short>
|
||||
</element>
|
||||
<element name="CompareBoolean.b1">
|
||||
<short></short>
|
||||
</element>
|
||||
<element name="CompareBoolean.b2">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="MergeSort">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="MergeSortWithLen">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="MergeSortWithLen.List">
|
||||
<short></short>
|
||||
</element>
|
||||
<element name="MergeSortWithLen.ListLength">
|
||||
<short></short>
|
||||
</element>
|
||||
<element name="MergeSortWithLen.Compare">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="MergeSort.List">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="MergeSort.ListLength">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="MergeSort.Compare">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="GetNextDelimitedItem">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="GetNextDelimitedItem.Result">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="GetNextDelimitedItem.List">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="GetNextDelimitedItem.Delimiter">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="GetNextDelimitedItem.Position">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="HasDelimitedItem">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="HasDelimitedItem.Result">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="HasDelimitedItem.List">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="HasDelimitedItem.Delimiter">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="HasDelimitedItem.FindItem">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="FindNextDelimitedItem">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="FindNextDelimitedItem.Result">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="FindNextDelimitedItem.List">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="FindNextDelimitedItem.Delimiter">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="FindNextDelimitedItem.Position">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="FindNextDelimitedItem.FindItem">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
</module> <!-- LazUtilities -->
|
||||
|
||||
</package>
|
||||
<element name="ConsoleVerbosity">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
</module>
|
||||
<!-- LazUtilities -->
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
|
||||
@ -1,46 +1,63 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions>
|
||||
<package name="lazutils">
|
||||
<package name="lazutils">
|
||||
<!--
|
||||
====================================================================
|
||||
LazUtilsStrConsts
|
||||
====================================================================
|
||||
-->
|
||||
<module name="LazUtilsStrConsts">
|
||||
<short>Resource strings used in the LazUtils package</short>
|
||||
<descr>
|
||||
LazUtilsStrConsts contains resource strings used in the LazUtils package. The resource strings are translated using the corresponding .pot file found in the languages directory.
|
||||
</descr>
|
||||
|
||||
<!--
|
||||
====================================================================
|
||||
LazUtilsStrConsts
|
||||
====================================================================
|
||||
-->
|
||||
<!-- resource string Visibility: default -->
|
||||
<element name="lrsModified"/>
|
||||
<element name="lrsInvalidCharSet"/>
|
||||
<element name="lrsSize"/>
|
||||
<element name="lrsFileDoesNotExist"/>
|
||||
<element name="lrsFileIsADirectoryAndNotAnExecutable"/>
|
||||
<element name="lrsReadAccessDeniedFor"/>
|
||||
<element name="lrsADirectoryComponentInDoesNotExistOrIsADanglingSyml"/>
|
||||
<element name="lrsADirectoryComponentInDoesNotExistOrIsADanglingSyml2"/>
|
||||
<element name="lrsADirectoryComponentInIsNotADirectory"/>
|
||||
<element name="lrsADirectoryComponentInIsNotADirectory2"/>
|
||||
<element name="lrsInsufficientMemory"/>
|
||||
<element name="lrsHasACircularSymbolicLink"/>
|
||||
<element name="lrsIsNotASymbolicLink"/>
|
||||
<element name="lrsIsNotExecutable"/>
|
||||
<element name="lrsUnableToCreateConfigDirectoryS"/>
|
||||
<element name="lrsProgramFileNotFound"/>
|
||||
<element name="lrsCanNotExecute"/>
|
||||
<element name="lrsListMustBeEmpty"/>
|
||||
<element name="lrsListIndexExceedsBounds"/>
|
||||
<element name="lrsERRORInCode"/>
|
||||
<element name="lrsCreatingGdbCatchableError"/>
|
||||
|
||||
<module name="LazUtilsStrConsts">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<!-- XPath resource strings -->
|
||||
<element name="lrsNodeSet"/>
|
||||
<element name="lrsBoolean"/>
|
||||
<element name="lrsNumber"/>
|
||||
<element name="lrsString"/>
|
||||
<element name="lrsVarNoConversion"/>
|
||||
<element name="lrsScannerUnclosedString"/>
|
||||
<element name="lrsScannerInvalidChar"/>
|
||||
<element name="lrsScannerMalformedQName"/>
|
||||
<element name="lrsScannerExpectedVarName"/>
|
||||
<element name="lrsParserExpectedLeftBracket"/>
|
||||
<element name="lrsParserExpectedRightBracket"/>
|
||||
<element name="lrsParserBadAxisName"/>
|
||||
<element name="lrsParserBadNodeType"/>
|
||||
<element name="lrsParserExpectedRightSquareBracket"/>
|
||||
<element name="lrsParserInvalidPrimExpr"/>
|
||||
<element name="lrsParserGarbageAfterExpression"/>
|
||||
<element name="lrsParserInvalidNodeTest"/>
|
||||
<element name="lrsEvalUnknownFunction"/>
|
||||
<element name="lrsEvalUnknownVariable"/>
|
||||
<element name="lrsEvalInvalidArgCount"/>
|
||||
|
||||
<!-- resource string Visibility: default -->
|
||||
<element name="rsModified">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- resource string Visibility: default -->
|
||||
<element name="sInvalidCharSet">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- resource string Visibility: default -->
|
||||
<element name="rsSize">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
</module> <!-- LazUtilsStrConsts -->
|
||||
|
||||
</package>
|
||||
</module>
|
||||
<!-- LazUtilsStrConsts -->
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
|
||||
@ -1,124 +1,95 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<fpdoc-descriptions>
|
||||
<package name="lazutils">
|
||||
<package name="lazutils">
|
||||
<!--
|
||||
====================================================================
|
||||
lcsvutils
|
||||
====================================================================
|
||||
-->
|
||||
<module name="lcsvutils">
|
||||
<short>
|
||||
Contains routines used to read and process Comma-separated values from a file or a stream
|
||||
</short>
|
||||
<descr>
|
||||
lcsvutils.pas contains routines used to read and process Comma-separated values from a file or a stream. It is used in the implementation of the LazUtils package and the TGrid component.
|
||||
</descr>
|
||||
|
||||
<!--
|
||||
====================================================================
|
||||
lcsvutils
|
||||
====================================================================
|
||||
-->
|
||||
<!-- procedure type Visibility: default -->
|
||||
<element name="TCSVRecordProc">
|
||||
<short>Procedure used to read and process comma-separated values</short>
|
||||
<descr>
|
||||
TCSVProc is a nested procedure used when reading and processing comma-separated values. A TCSVProc reference is passed as an argument to the LoadFromCSVFile and LoadFromCSVStream routines. Applications must create a procedure that performs actions required when a line of CSV of data has been read from its data source and separated into individual field values.
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCSVRecordProc.Fields">
|
||||
<short>TStringList used to store comma-separated field values</short>
|
||||
</element>
|
||||
|
||||
<module name="lcsvutils">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<element name="TCSVEncoding">
|
||||
<short>Represents character encodings used for values in CSV data</short>
|
||||
<descr>
|
||||
TCSVEncoding is an enumerated type which represents character encodings that can be used for CSV data.
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCSVEncoding.ceAuto">
|
||||
<short>Auto-detects character encoding applied to the CSV data</short>
|
||||
</element>
|
||||
<element name="TCSVEncoding.ceUTF8">
|
||||
<short>CSV data uses the UTF-8 encoding</short>
|
||||
</element>
|
||||
<element name="TCSVEncoding.ceUTF16">
|
||||
<short>CSV data uses the UTF-16 encoding</short>
|
||||
</element>
|
||||
<element name="TCSVEncoding.ceUTF16be">
|
||||
<short>CSV data uses the UTF-16 Big-Endian encoding</short>
|
||||
</element>
|
||||
|
||||
<!-- procedure type Visibility: default -->
|
||||
<element name="TCSVRecordProc">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="LoadFromCSVStream">
|
||||
<short>
|
||||
Loads and processes comma-separated values from the specified stream
|
||||
</short>
|
||||
<descr></descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="LoadFromCSVStream.AStream">
|
||||
<short>TStream instance containing the CSV data</short>
|
||||
</element>
|
||||
<element name="LoadFromCSVStream.AProc">
|
||||
<short>Routine used to load and process records in the CSV data</short>
|
||||
</element>
|
||||
<element name="LoadFromCSVStream.ADelimiter">
|
||||
<short>Delimiter used to separate fields in the CSV data</short>
|
||||
</element>
|
||||
<element name="LoadFromCSVStream.CSVEncoding">
|
||||
<short>Character encoding used for the CSV data</short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCSVRecordProc.Fields">
|
||||
<short></short>
|
||||
</element>
|
||||
<element name="LoadFromCSVFile">
|
||||
<short>
|
||||
Loads and process comma-separated valued from the specified file
|
||||
</short>
|
||||
<descr></descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="LoadFromCSVFile.aFilename">
|
||||
<short>File name which contains the CSV data</short>
|
||||
</element>
|
||||
<element name="LoadFromCSVFile.AProc">
|
||||
<short>Routine used to load and process records in the CSV data</short>
|
||||
</element>
|
||||
<element name="LoadFromCSVFile.ADelimiter">
|
||||
<short>Delimiter used to separate fields in the CSV data</short>
|
||||
</element>
|
||||
<element name="LoadFromCSVFile.CSVEncoding">
|
||||
<short>Character encoding used for the CSV data</short>
|
||||
</element>
|
||||
|
||||
<!-- enumeration type Visibility: default -->
|
||||
<element name="TCSVEncoding">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
</module>
|
||||
<!-- lcsvutils -->
|
||||
|
||||
<!-- enumeration value Visibility: default -->
|
||||
<element name="TCSVEncoding.ceAuto">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- enumeration value Visibility: default -->
|
||||
<element name="TCSVEncoding.ceUTF8">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- enumeration value Visibility: default -->
|
||||
<element name="TCSVEncoding.ceUTF16">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- enumeration value Visibility: default -->
|
||||
<element name="TCSVEncoding.ceUTF16be">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="LoadFromCSVStream">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="LoadFromCSVStream.AStream">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="LoadFromCSVStream.AProc">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="LoadFromCSVStream.ADelimiter">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="LoadFromCSVStream.CSVEncoding">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="LoadFromCSVFile">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="LoadFromCSVFile.aFilename">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="LoadFromCSVFile.AProc">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="LoadFromCSVFile.ADelimiter">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="LoadFromCSVFile.CSVEncoding">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
</module> <!-- lcsvutils -->
|
||||
|
||||
</package>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user