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

Docs: LazUtils/lazstringutils. Removes topic for deprecated routine in #9a816398.

Browse Source
This commit is contained in:
dsiders 2021-10-31 15:23:34 +01:00
parent 18bece2476
commit 7c2368058c
1 changed files with 0 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/xml/lazutils/lazstringutils.xml
View File

@ -441,33 +441,6 @@
<short>True when invalid UTF-8 codepoints are repaired in the string.</short>
</element>
<element name="SpecialCharsToHex">
<short>Converts special characters to Pascal-style hexadecimal character constants.</short>
<descr>
<p>
<var>SpecialCharsToHex</var> is a <var>String</var> function used to convert special or control characters (those prior to the Space character Decimal 32) to their representation as a Pascal-style hexadecimal character constant using notation like <b>#$1B</b>. Other character values in <var>s </var> are not altered in any way.
</p>
<p>
SpecialCharsToHex calls <var>Utf8EscapeControlChars</var> in <file>LazUtf8</file> to get the return value for the function. The value <var>emHexPascal</var> is passed as an argument to request hexadecimal notation in the special characters.
</p>
<p>
SpecialCharsToHex is used in the implementation of the Search Result view in the Lazarus IDE.
</p>
<remark>
SpecialCharsToHex has been <b>deprecated</b> in Lazarus 2.1, and will be removed in Lazarus 2.3. Use the <var>Utf8EscapeControlChars</var> routine in <file>LazUtf8.pas</file> instead.
</remark>
</descr>
<seealso>
<link id="#lazutils.lazutf8.Utf8EscapeControlChars">Utf8EscapeControlChars</link>
</seealso>
</element>
<element name="SpecialCharsToHex.Result">
<short>String after converting special characters to Pascal-style constants.</short>
</element>
<element name="SpecialCharsToHex.s">
<short>Values examined and converted in the routine.</short>
</element>
<element name="ShortDotsLine">
<short>Shortens and "ellipsifies" the specified value.</short>
<descr>