paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-09 03:48:08 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL/lclproc. Adds AddCmdLineParamDesc topic for changes in f0eb9b84. Issue #40690.

Browse Source
This commit is contained in:
dsiders 2024-01-20 04:00:55 +00:00
parent 3e8fd84cf3
commit f846d08eef
1 changed files with 51 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
docs/xml/lcl/lclproc.xml
View File

@ -1659,15 +1659,63 @@ package for replacements.
</element>
<element name="IsFontNameDefault">
<short>Indicates if the specified name contains 'default'.</short>
<short>
Indicates whether the specified font name contains 'default'.
</short>
<descr/>
<seealso/>
</element>
<element name="IsFontNameDefault.Result">
<short><b>True</b> when AName contains 'default'.</short>
<short>
<b>True</b> when AName contains 'default'.
</short>
</element>
<element name="IsFontNameDefault.AName">
<short>Font name examined in the routine.</short>
<short>
Font name examined in the routine.
</short>
</element>
<!-- TODO: Added in f0eb9b84. Issue #40690. -->
<element name="AddCmdLineParamDesc">
<short>
Adds the help displayed for a command line parameter (and options) to the
specified TStringList instance.
</short>
<descr>
<p>
<var>AddCmdLineParamDesc</var> stores the values from <var>aParamOpts</var> and
<var>aDescr</var> as separate lines appended to the string list in
<var>aText</var>. Multiple values in aParamOpts are combined into a
comma-delimited list and added as a single line to AText. aDescr is appended to
aText as the last entry.
</p>
<p>
No actions are performed in the routine if aParamOpts is an empty array (Length
= 0).
</p>
</descr>
<version>
Added in LCL 4.0.
</version>
<seealso/>
</element>
<element name="AddCmdLineParamDesc.aText">
<short>
TStringList instance where the formatted help output is stored.
</short>
</element>
<element name="AddCmdLineParamDesc.aParamOpts">
<short>
Array with the list of parameters / options for the generated help content.
Normally contains the short and/or long variants of the command line switch(es)
and any argument(s).
</short>
</element>
<element name="AddCmdLineParamDesc.aDescr">
<short>
Descriptive text for the specified parameter(s).
</short>
</element>
</module>