paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-07-29 07:57:01 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Documentation updates for LCL and LazUtils. Issue #36392, patch from Don Siders.

Browse Source 
git-svn-id: trunk@62328 -
This commit is contained in:
juha 2019-12-05 20:55:51 +00:00
parent dd3e6c3681
commit fe2f85d8e6
2 changed files with 2691 additions and 1531 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

182
docs/xml/lazutils/fpcadds.xml
View File

@ -1,92 +1,114 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions> <fpdoc-descriptions>
<package name="lcl"> <package name="lazutils">
<!--
====================================================================
FPCAdds
====================================================================
-->
<module name="FPCAdds">
<short>
Contains additional types and routines not currently available in FPC
</short>
<descr>
<file>fpcadds.pas</file> contains code in its initialization section to set the code page for conversions and the <var>RTL</var> file system to <var>CP_UTF8</var>. The initialization code is included only for platforms or OS-es where the <var>RTL</var> (<b>Run-Time Library</b>) is UTF-8-enabled.
</descr>
<!-- <!-- unresolved type references Visibility: default -->
==================================================================== <element name="Classes"/>
FPCAdds <element name="SysUtils"/>
====================================================================
-->
<module name="FPCAdds"> <element name="TStreamSeekType">
<short/> <short>Alias to the Int64 type used as the origin for TStream seek operations</short>
<descr> <descr>
</descr> <p>
Used in the implementation of classes including:
</p>
<ul>
<li>TBitmap</li>
<li>TIcon</li>
<li>TSharedCursorImage</li>
<li>TImageList</li>
<li>TClipboard</li>
</ul>
</descr>
<seealso></seealso>
</element>
<!-- unresolved type reference Visibility: default --> <element name="TMemStreamSeekType">
<element name="Classes"> <short>Alias to the PtrInt type used as the origin for TMemoryStream seek operations</short>
<short/> <descr>
<descr> Used in the implementation of <var>TSynCustomExporter</var>.
</descr> </descr>
<seealso> <seealso></seealso>
</seealso> </element>
</element>
<!-- unresolved type reference Visibility: default --> <element name="TCompareMemSize">
<element name="SysUtils"> <short>Alias to the PtrUInt type used when comparing memory blocks</short>
<short/> <descr>
<descr> Used in the implementation of <var>TSynCustomExporter</var> and <var>TGraphic</var>.
</descr> </descr>
<seealso> <seealso></seealso>
</seealso> </element>
</element>
<!-- alias type Visibility: default --> <element name="PHandle">
<element name="TStreamSeekType"> <short>Type used for a pointer to a THandle type</short>
<short/> <descr>
<descr> Also defined in <file>lcltype.pp</file>.
</descr> </descr>
<seealso> <seealso></seealso>
</seealso> </element>
</element>
<!-- alias type Visibility: default --> <element name="StrToWord">
<element name="TMemStreamSeekType"> <short>Converts the value in a String to a Word data type</short>
<short/> <descr></descr>
<descr> <seealso></seealso>
</descr> </element>
<seealso> <element name="StrToWord.Result">
</seealso> <short>Word value calculated for the specified String</short>
</element> </element>
<element name="StrToWord.s">
<short>String value examined in the method</short>
</element>
<!-- alias type Visibility: default --> <element name="AlignToPtr">
<element name="TCompareMemSize"> <short>
<short/> Aligns the specified pointer to the boundaries required for the FPC compiler
<descr> </short>
</descr> <descr>
<seealso> <p>
</seealso> <var>AlignToPtr</var> is a <var>Pointer</var> function used to adjust the pointer specified in <var>p</var> to the boundaries required for the FPC compiler. AlignToPtr is influenced by the <b>FPC_REQUIRES_PROPER_ALIGNMENT</b> compiler define; when it is defined, the Align routine is called to adjust the pointer to the size required for Pointer data types. When it is not defined, the pointer in <var>p</var> does not require alignment, and is used as the return value.
</element> </p>
</descr>
<seealso>
<link id=AlignToInt""/>
</seealso>
</element>
<element name="AlignToPtr.p">
<short>Pointer affected in the routine</short>
</element>
<!-- pointer type Visibility: default --> <element name="AlignToInt">
<element name="PHandle"> <short>
<short/> Aligns the specified pointer to the size of an Integer data type
<descr> </short>
</descr> <descr>
<seealso> <p>
</seealso> <var>AlignToInt</var> is a <var>Pointer</var> function used to adjust the pointer in <var>p</var> to the size needed for an <var>Integer</var> data type. <var>AlignToInt</var> is influenced by the <b>FPC_REQUIRES_PROPER_ALIGNMENT</b> compiler define; when it is defined, the <var>Align</var> routine is called to adjust the pointer size to the boundaries required for an <var>Integer</var> data type. When it is not defined, the pointer in <var>p</var> is used as the return value.
</element> </p>
</descr>
<notes>
<note>Not currently used in any other units.</note>
</notes>
<seealso>
<link id="AlignToPtr"/>
</seealso>
</element>
<element name="AlignToInt.p">
<short></short>
</element>
<!-- function Visibility: default --> </module>
<element name="StrToWord"> <!-- FPCAdds -->
<short/> </package>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="StrToWord.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="StrToWord.s">
<short/>
</element>
</module> <!-- FPCAdds -->
</package>
</fpdoc-descriptions> </fpdoc-descriptions>

4040
docs/xml/lcl/buttons.xml
View File

File diff suppressed because it is too large Load Diff