updated docs

pavkam · Mar 9, 2018 · 4647390 · 4647390
1 parent bc288b7
commit 4647390
Show file tree

Hide file tree

Showing 24 changed files with 1,354 additions and 186 deletions.
diff --git a/PasDocSettings.pds b/PasDocSettings.pds
@@ -4,15 +4,15 @@ Language=en
 OutputDir=docs
 GenerateFormat=0
 ProjectName=
-Verbosity=2
+Verbosity=3
 ClassMembers_0=1
 ClassMembers_1=1
 ClassMembers_2=1
 ClassMembers_3=0
 ClassMembers_4=0
 ClassMembers_5=0
 ClassMembers_6=1
-ClassMembers_7=0
+ClassMembers_7=1
 ImplicitVisibility=0
 Sorting_0=1
 Sorting_1=1
@@ -28,7 +28,7 @@ CssFileName=
 IntroductionFileName=
 ConclusionFileName=
 WriteUsesList=1
-AutoAbstract=0
+AutoAbstract=1
 AutoLink=1
 HandleMacros=0
 UseTipueSearch=1
@@ -40,24 +40,27 @@ VizGraphUses=0
 CheckSpelling=1
 LatexGraphicsPackage=0
 [Defines]
-Count=5
-Item_0=UNICODE
-Item_1=MSWINDOWS
-Item_2=WIN32
-Item_3=CPU386
-Item_4=CONDITIONALEXPRESSIONS
+Count=6
+Item_0=PASDOC
+Item_1=UNICODE
+Item_2=MSWINDOWS
+Item_3=WIN32
+Item_4=CPU386
+Item_5=CONDITIONALEXPRESSIONS
 [Header]
 Count=1
 Item_0=TZDB for Delphi Documentation by pasdoc 2018-03-04
 [Footer]
 Count=1
 Item_0=prepared by M.Taylor
 [IncludeDirectories]
-Count=1
+Count=2
 Item_0=src\TZDBPK
+Item_1=src\TZDBLIB
 [Files]
-Count=1
-Item_0=src\TZDBPK\TZDB.pas
+Count=2
+Item_0=src\TZDBLIB\TZCAPI.pas
+Item_1=src\TZDBPK\TZDB.pas
 [HyphenatedWords]
 Count=0
 [SpecialMarkers]

diff --git a/docs/AllClasses.html b/docs/AllClasses.html
@@ -4,7 +4,7 @@
 <title>Delphi TZDB: All Classes, Interfaces, Objects and Records</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta name="generator" content="PasDoc 0.15.0">
-<meta http-equiv="content-type" content="text/html; charset=UTF-8">
+<meta http-equiv="content-type" content="text/html; charset=utf-8">
 <link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">
 
 <link rel="StyleSheet" type="text/css" href="pasdoc.css">
@@ -26,24 +26,36 @@ <h2>Delphi TZDB</h2><p><a href="AllUnits.html" class="navigation">Units</a></p><
 });
 </script>
 </td><td class="content">
-TZDB for Delphi Documentation by pasdoc 2018-03-04<h1 class="allitems">All Classes, Interfaces, Objects and Records</h1>
+TZDB for Delphi Documentation by pasdoc 2018-03-04
+<h1 class="allitems">All Classes, Interfaces, Objects and Records</h1>
 <table class="itemstable wide_list">
 <tr class="listheader">
 <th class="itemname">Name</th>
 <th class="itemunit">Unit</th>
 <th class="itemdesc">Description</th>
 </tr>
 <tr class="list">
-<td class="itemname"><a class="bold" href="TZDB.ETimeZoneInvalid.html">ETimeZoneInvalid</a></td>
+<td class="itemname"><a class="bold" href="TZDB.ELocalTimeInvalid.html">ELocalTimeInvalid</a></td>
 <td class="itemunit"><a class="bold" href="TZDB.html">TZDB</a></td>
-<td class="itemdesc"><p>Exception type used to signal the caller code that a requested time zone is not present in the bundled database or that its format is invalid.</p></td>
+<td class="itemdesc"><p>&lt;summary&gt;Exception thrown when the passed local time is invalid.&lt;/summary&gt;</p></td>
 </tr>
 <tr class="list2">
+<td class="itemname"><a class="bold" href="TZDB.ETimeZoneInvalid.html">ETimeZoneInvalid</a></td>
+<td class="itemunit"><a class="bold" href="TZDB.html">TZDB</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;Exception type used to signal the caller code that a requested time zone is not present in the bundled database or that its format is invalid.&lt;/summary&gt;</p></td>
+</tr>
+<tr class="list">
 <td class="itemname"><a class="bold" href="TZDB.TBundledTimeZone.html">TBundledTimeZone</a></td>
 <td class="itemunit"><a class="bold" href="TZDB.html">TZDB</a></td>
-<td class="itemdesc"><p>A timezone class implementation that retreives its data from the bundled database.</p></td>
+<td class="itemdesc"><p>&lt;summary&gt;A timezone class implementation that retreives its data from the bundled database.&lt;/summary&gt; &lt;remarks&gt;This class inherits the standard &lt;c&gt;TTimeZone&lt;/c&gt; class in Delphi XE.&lt;/remarks&gt;</p></td>
+</tr>
+<tr class="list2">
+<td class="itemname"><a class="bold" href="TZCAPI.TZ_Instance.html">TZ_Instance</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;An opaque structure that identifies a time zone object.&lt;/summary&gt;</p></td>
 </tr>
 </table>
-prepared by M.Taylor<hr><span class="appinfo"><em>Generated by <a  href="https://github.com/pasdoc/pasdoc/wiki">PasDoc 0.15.0</a>. </em>
+prepared by M.Taylor
+<hr><span class="appinfo"><em>Generated by <a  href="https://github.com/pasdoc/pasdoc/wiki">PasDoc 0.15.0</a>. </em>
 </span>
 </td></tr></table></body></html>
diff --git a/docs/AllConstants.html b/docs/AllConstants.html
@@ -4,7 +4,7 @@
 <title>Delphi TZDB: All Constants</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta name="generator" content="PasDoc 0.15.0">
-<meta http-equiv="content-type" content="text/html; charset=UTF-8">
+<meta http-equiv="content-type" content="text/html; charset=utf-8">
 <link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">
 
 <link rel="StyleSheet" type="text/css" href="pasdoc.css">
@@ -26,9 +26,56 @@ <h2>Delphi TZDB</h2><p><a href="AllUnits.html" class="navigation">Units</a></p><
 });
 </script>
 </td><td class="content">
-TZDB for Delphi Documentation by pasdoc 2018-03-04<h1 class="allitems">All Constants</h1>
-<p>
-The units do not contain any constants.</p>
-prepared by M.Taylor<hr><span class="appinfo"><em>Generated by <a  href="https://github.com/pasdoc/pasdoc/wiki">PasDoc 0.15.0</a>. </em>
+TZDB for Delphi Documentation by pasdoc 2018-03-04
+<h1 class="allitems">All Constants</h1>
+<table class="itemstable wide_list">
+<tr class="listheader">
+<th class="itemname">Name</th>
+<th class="itemunit">Unit</th>
+<th class="itemdesc">Description</th>
+</tr>
+<tr class="list">
+<td class="itemname"><a class="bold" href="TZCAPI.html#ERROR_INST_DISPOSED">ERROR_INST_DISPOSED</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;The time zone instance passed to the function was detected as being disposed.&lt;/summary&gt;</p></td>
+</tr>
+<tr class="list2">
+<td class="itemname"><a class="bold" href="TZCAPI.html#ERROR_INVALID_ARG">ERROR_INVALID_ARG</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;An argument passed to the function was invalid.&lt;/summary&gt;</p></td>
+</tr>
+<tr class="list">
+<td class="itemname"><a class="bold" href="TZCAPI.html#ERROR_INVALID_LOCAL_TIME">ERROR_INVALID_LOCAL_TIME</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;The local time value passed to the function was invalid in the given time zone.&lt;/summary&gt;</p></td>
+</tr>
+<tr class="list2">
+<td class="itemname"><a class="bold" href="TZCAPI.html#ERROR_UNKNOWN">ERROR_UNKNOWN</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;A generic error.</p></td>
+</tr>
+<tr class="list">
+<td class="itemname"><a class="bold" href="TZCAPI.html#LOCAL_TIME_AMBIGUOUS">LOCAL_TIME_AMBIGUOUS</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;The local time is in DST -&gt; Standard year period.&lt;/summary&gt;</p></td>
+</tr>
+<tr class="list2">
+<td class="itemname"><a class="bold" href="TZCAPI.html#LOCAL_TIME_DAYLIGHT">LOCAL_TIME_DAYLIGHT</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;The local time is in the DST year period.&lt;/summary&gt;</p></td>
+</tr>
+<tr class="list">
+<td class="itemname"><a class="bold" href="TZCAPI.html#LOCAL_TIME_INVALID">LOCAL_TIME_INVALID</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;The local time is in the Standard -&gt; DST year period.&lt;/summary&gt;</p></td>
+</tr>
+<tr class="list2">
+<td class="itemname"><a class="bold" href="TZCAPI.html#LOCAL_TIME_STANDARD">LOCAL_TIME_STANDARD</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;The local time is in the Standard year period.&lt;/summary&gt;</p></td>
+</tr>
+</table>
+prepared by M.Taylor
+<hr><span class="appinfo"><em>Generated by <a  href="https://github.com/pasdoc/pasdoc/wiki">PasDoc 0.15.0</a>. </em>
 </span>
 </td></tr></table></body></html>
diff --git a/docs/AllFunctions.html b/docs/AllFunctions.html
@@ -4,7 +4,7 @@
 <title>Delphi TZDB: All Functions and Procedures</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta name="generator" content="PasDoc 0.15.0">
-<meta http-equiv="content-type" content="text/html; charset=UTF-8">
+<meta http-equiv="content-type" content="text/html; charset=utf-8">
 <link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">
 
 <link rel="StyleSheet" type="text/css" href="pasdoc.css">
@@ -26,9 +26,61 @@ <h2>Delphi TZDB</h2><p><a href="AllUnits.html" class="navigation">Units</a></p><
 });
 </script>
 </td><td class="content">
-TZDB for Delphi Documentation by pasdoc 2018-03-04<h1 class="allitems">All Functions and Procedures</h1>
-<p>
-The units do not contain any functions or procedures.</p>
-prepared by M.Taylor<hr><span class="appinfo"><em>Generated by <a  href="https://github.com/pasdoc/pasdoc/wiki">PasDoc 0.15.0</a>. </em>
+TZDB for Delphi Documentation by pasdoc 2018-03-04
+<h1 class="allitems">All Functions and Procedures</h1>
+<table class="itemstable wide_list">
+<tr class="listheader">
+<th class="itemname">Name</th>
+<th class="itemunit">Unit</th>
+<th class="itemdesc">Description</th>
+</tr>
+<tr class="list">
+<td class="itemname"><a class="bold" href="TZCAPI.html#TZ_EnumTimeZones">TZ_EnumTimeZones</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;Lists all known/supported time zone names.&lt;/summary&gt; &lt;param name=&quot;Data&quot;&gt;User provided data that is passed along to &lt;paramref name=&quot;EnumProc&quot;/&gt;.&lt;/param&gt; &lt;param name=&quot;IncludeAliases&quot;&gt;Pass &lt;c&gt;True&lt;/c&gt; to include time zone aliases into the list.&lt;/param&gt; &lt;param name=&quot;EnumProc&quot;&gt;The enumerator procedure called for each item in the list.&lt;/param&gt; &lt;returns&gt;&lt;c&gt;True&lt;/c&gt; is returned if the enumeration process was interrupted by the consumer.</p></td>
+</tr>
+<tr class="list2">
+<td class="itemname"><a class="bold" href="TZCAPI.html#TZ_GetAbbreviation">TZ_GetAbbreviation</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;Generates an abbreviation string for the given local time.&lt;/summary&gt; &lt;param name=&quot;Instance&quot;&gt;The time zone instance.&lt;/param&gt; &lt;param name=&quot;Time&quot;&gt;The local time (C format).&lt;/param&gt; &lt;param name=&quot;ForceDaylight&quot;&gt;Specify a &lt;c&gt;True&lt;/c&gt; value if ambiguous periods should be treated as DST.&lt;/param&gt; &lt;param name=&quot;Abbrev&quot;&gt;The output string parameter.</p></td>
+</tr>
+<tr class="list">
+<td class="itemname"><a class="bold" href="TZCAPI.html#TZ_GetDisplayName">TZ_GetDisplayName</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;Generates a diplay name for the given local time.&lt;/summary&gt; &lt;param name=&quot;Instance&quot;&gt;The time zone instance.&lt;/param&gt; &lt;param name=&quot;Time&quot;&gt;The local time (C format).&lt;/param&gt; &lt;param name=&quot;ForceDaylight&quot;&gt;Specify a &lt;c&gt;True&lt;/c&gt; value if ambiguous periods should be treated as DST.&lt;/param&gt; &lt;param name=&quot;DispName&quot;&gt;The output string parameter.</p></td>
+</tr>
+<tr class="list2">
+<td class="itemname"><a class="bold" href="TZCAPI.html#TZ_GetLocalTimeType">TZ_GetLocalTimeType</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;Returns the type of the local time.&lt;/summary&gt; &lt;param name=&quot;Instance&quot;&gt;The time zone instance.&lt;/param&gt; &lt;param name=&quot;Time&quot;&gt;The local time.&lt;/param&gt; &lt;returns&gt;A zero or a positive result means success.</p></td>
+</tr>
+<tr class="list">
+<td class="itemname"><a class="bold" href="TZCAPI.html#TZ_GetUtcOffset">TZ_GetUtcOffset</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;Returns the UTC offset of the given local time.&lt;/summary&gt; &lt;param name=&quot;Instance&quot;&gt;The time zone instance.&lt;/param&gt; &lt;param name=&quot;Time&quot;&gt;The local time.&lt;/param&gt; &lt;param name=&quot;ForceDaylight&quot;&gt;Specify a &lt;c&gt;True&lt;/c&gt; value if ambiguous periods should be treated as DST.&lt;/param&gt; &lt;param name=&quot;TimeType&quot;&gt;An output parameter to which the UTC offset if copied.&lt;/param&gt; &lt;returns&gt;A zero or a positive value means success.</p></td>
+</tr>
+<tr class="list2">
+<td class="itemname"><a class="bold" href="TZCAPI.html#TZ_InitInstance">TZ_InitInstance</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;Looks up a time zone object by the given &lt;paramref name=&quot;Name&quot;/&gt;.&lt;/summary&gt; &lt;param name=&quot;Name&quot;&gt;The name time zone name to lookup.</p></td>
+</tr>
+<tr class="list">
+<td class="itemname"><a class="bold" href="TZCAPI.html#TZ_LocalToUtc">TZ_LocalToUtc</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;Converts a local time to UTC time.&lt;/summary&gt; &lt;param name=&quot;Instance&quot;&gt;The time zone instance.&lt;/param&gt; &lt;param name=&quot;LocalTime&quot;&gt;The local time to be converted.&lt;/param&gt; &lt;param name=&quot;ForceDaylight&quot;&gt;Specify a &lt;c&gt;True&lt;/c&gt; value if ambiguous periods should be treated as DST.&lt;/param&gt; &lt;param name=&quot;UtcTime&quot;&gt;The output parameter to hold the converted UTC time.&lt;/param&gt; &lt;returns&gt;A zero or a positive value means success.</p></td>
+</tr>
+<tr class="list2">
+<td class="itemname"><a class="bold" href="TZCAPI.html#TZ_ReleaseInstance">TZ_ReleaseInstance</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;Releases a previously acquired instance.&lt;/summary&gt; &lt;param name=&quot;Instance&quot;&gt;The time zone instance.&lt;/param&gt; &lt;returns&gt;A zero or a positive value means success.</p></td>
+</tr>
+<tr class="list">
+<td class="itemname"><a class="bold" href="TZCAPI.html#TZ_UtcToLocal">TZ_UtcToLocal</a></td>
+<td class="itemunit"><a class="bold" href="TZCAPI.html">TZCAPI</a></td>
+<td class="itemdesc"><p>&lt;summary&gt;Converts an UTC time to a local time.&lt;/summary&gt; &lt;param name=&quot;Instance&quot;&gt;The time zone instance.&lt;/param&gt; &lt;param name=&quot;UtcTime&quot;&gt;The UTC time to be converted.&lt;/param&gt; &lt;param name=&quot;LocalTime&quot;&gt;The output parameter to hold the converted local time.&lt;/param&gt; &lt;returns&gt;A zero or a positive value means success.</p></td>
+</tr>
+</table>
+prepared by M.Taylor
+<hr><span class="appinfo"><em>Generated by <a  href="https://github.com/pasdoc/pasdoc/wiki">PasDoc 0.15.0</a>. </em>
 </span>
 </td></tr></table></body></html>