Skip to content

Commit cbdb9b0

Browse files
delphidabblerdelphidabbler
committed
Made all DescEx and Extra values REML conformant
Achieved by adding enclosing <p>..</p> tags to all REML that didn't have it.
1 parent 8d31ab3 commit cbdb9b0

20 files changed

+97
-97
lines changed

‎csdb/collection/arrays.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Delphi10S=Y
140140
FPC=Y
141141

142142
[AppendByteArray]
143-
DescEx="Appends array of bytes <var>B2</var> to the end of byte array <var>B1</var>."
143+
DescEx="<p>Appends array of bytes <var>B2</var> to the end of byte array <var>B1</var>.</p>"
144144
Depends=TBytes
145145
SeeAlso=ConcatByteArrays
146146
Snip=364.dat

‎csdb/collection/consts.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[SHIL_Enum]
99
Kind=const
1010
DisplayName=SHIL_* Constants
11-
DescEx="Constants that can be passed as flags to specify the required image type in calls to the <var>SysImageListHandleEx</var> routine."
11+
DescEx="<p>Constants that can be passed as flags to specify the required image type in calls to the <var>SysImageListHandleEx</var> routine.</p>"
1212
Extra="<p>Contributed by Bill Miller.</p>"
1313
SeeAlso=SysImageListHandleEx
1414
Snip=332.dat

‎csdb/collection/date.ini

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -751,7 +751,7 @@ Delphi10S=Y
751751
FPC=Y
752752

753753
[MSecToDateTime]
754-
DescEx="Converts the given number of milliseconds to a <var>TDateTime</var> value."
754+
DescEx="<p>Converts the given number of milliseconds to a <var>TDateTime</var> value.</p>"
755755
Units=SysUtils
756756
Snip=458.dat
757757
Delphi2=N
@@ -797,7 +797,7 @@ Delphi10S=Y
797797
FPC=Y
798798

799799
[SQLDateToDateTime]
800-
DescEx="Converts a date in SQL format into a <var>TDateTime</var>."
800+
DescEx="<p>Converts a date in SQL format into a <var>TDateTime</var>.</p>"
801801
Extra="<p>Handles only the date component. Any time component is ignored.</p>"
802802
Units=SysUtils
803803
SeeAlso=SQLDate
@@ -1225,7 +1225,7 @@ Delphi10S=Y
12251225
FPC=Y
12261226

12271227
[RFC2822Date]
1228-
DescEx="Returns the RFC 2822 representation of the date (in local time) specified in the <var>LocalTime</var> parameter. The <var>IsDST</var> parameter indicates whether <var>LocalTime</var> is in daylight saving time or not."
1228+
DescEx="<p>Returns the RFC 2822 representation of the date (in local time) specified in the <var>LocalTime</var> parameter. The <var>IsDST</var> parameter indicates whether <var>LocalTime</var> is in daylight saving time or not.</p>"
12291229
Extra="<p>This date format is defined by section 3.3 of <a href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2882</a>.</p>"
12301230
Units=SysUtils,Windows
12311231
Snip=374.dat
@@ -1248,7 +1248,7 @@ Delphi10S=Y
12481248
FPC=Y
12491249

12501250
[SecondsToTime]
1251-
DescEx="Converts a number of seconds into a <var>TDateTime</var> value."
1251+
DescEx="<p>Converts a number of seconds into a <var>TDateTime</var> value.</p>"
12521252
Extra="<p>This routine uses knowledge of the internal composition of a <var>TDateTime</var>.</p>"
12531253
Units=SysUtils
12541254
Snip=357.dat

‎csdb/collection/drive.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ FPC=Y
215215

216216
[GetDriveNumber]
217217
DescEx="<p>Returns the zero based drive number for given drive. -1 is returned if drive name does not start with a valid drive letter in the range A..Z.</p>"
218-
Extra="<var>Drive</var> can be specified as a disk letter (e.g. <mono>C</mono>), a drive name (e.g <mono>C:</mono> or <mono>C:\</mono>) or an absolute file path on the drive (e.g. <mono>C:\Foo\Bar.txt</mono>)."
218+
Extra="<p><var>Drive</var> can be specified as a disk letter (e.g. <mono>C</mono>), a drive name (e.g <mono>C:</mono> or <mono>C:\</mono>) or an absolute file path on the drive (e.g. <mono>C:\Foo\Bar.txt</mono>).</p>"
219219
Units=SysUtils
220220
Depends=IsCharInSet
221221
SeeAlso=IsValidDriveNum

‎csdb/collection/encoding.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# https://gravatar.com/delphidabbler
77

88
[BytesToAnsiString]
9-
DescEx="Converts the given array of bytes to an ANSI raw byte string, which is returned. The returned string has the code page specified by <var>CodePage</var>."
9+
DescEx="<p>Converts the given array of bytes to an ANSI raw byte string, which is returned. The returned string has the code page specified by <var>CodePage</var>.</p>"
1010
Extra="<p>Based on code from the Stack Overflow posting <a href="http://stackoverflow.com/questions/773297/how-can-i-convert-tbytes-to-rawbytestring">How can I convert TBytes to RawByteString?</a>.</p>"
1111
Units=SysUtils
1212
Snip=359.dat

‎csdb/collection/file.ini

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# https://gravatar.com/delphidabbler
77

88
[CopyFile]
9-
DescEx="Copies <var>Source</var> file to <var>Dest</var> file, preserving modification date."
9+
DescEx="<p>Copies <var>Source</var> file to <var>Dest</var> file, preserving modification date.</p>"
1010
Units=Classes,SysUtils
1111
SeeAlso=CopyFiles
1212
Snip=029.dat
@@ -309,7 +309,7 @@ Delphi10S=Y
309309
FPC=Y
310310

311311
[GetFixedFileVerInfo]
312-
DescEx="Extracts fixed version information from file named by <var>FileName</var>. If file contains version information it is returned via <var>FFI</var> parameter and function returns True, otherwise False is returned and <var>FFI</var> is undefined."
312+
DescEx="<p>Extracts fixed version information from file named by <var>FileName</var>.</p><p>If file contains version information it is returned via <var>FFI</var> parameter and function returns True, otherwise False is returned and <var>FFI</var> is undefined.</p>"
313313
Units=Windows
314314
SeeAlso=HasVerInfo
315315
Snip=010.dat
@@ -896,7 +896,7 @@ Delphi10S=Y
896896
FPC=Y
897897

898898
[IsDirectory]
899-
DescEx="Returns True if given name is a valid directory and False otherwise. <var>DirName</var> can be any file system name (with or without trailing path delimiter)."
899+
DescEx="<p>Returns True if given name is a valid directory and False otherwise. <var>DirName</var> can be any file system name (with or without trailing path delimiter).</p>"
900900
Extra="<p>This routine avoids using <var>DirectoryExists</var> in <mono>FileCtrl</mono> and hence avoids the overhead of using that unit.</p>"
901901
Units=SysUtils
902902
Depends=IsFlagSet
@@ -1065,7 +1065,7 @@ Delphi10S=Y
10651065
FPC=Y
10661066

10671067
[SubDirectoryCount]
1068-
DescEx="Counts all the sub-directories of directory specified by <var>Path</var>. If <var>Recurse</var> is True all sub-directories are counted recursively, otherwise only immediate sub-directories are counted."
1068+
DescEx="<p>Counts all the sub-directories of directory specified by <var>Path</var>.</p><p>If <var>Recurse</var> is True all sub-directories are counted recursively, otherwise only immediate sub-directories are counted.</p>"
10691069
Extra="<p>Adapted from code contributed by Bill Miller.</p>"
10701070
Units=IOUtils,Types
10711071
Snip=409.dat
@@ -1088,7 +1088,7 @@ Delphi10S=Y
10881088
FPC=N
10891089

10901090
[TempFileName]
1091-
DescEx="Returns a unique temporary file name in the user's <mono>Temp</mono> folder. The file name includes the first three characters of <var>Stub</var> followed by hexadecimal characters. If <var>Create</var> is True then the file is created. Returns an empty string on failure."
1091+
DescEx="<p>Returns a unique temporary file name in the user's <mono>Temp</mono> folder. The file name includes the first three characters of <var>Stub</var> followed by hexadecimal characters.</p><p>If <var>Create</var> is True then the file is created. Returns an empty string on failure.</p>"
10921092
Extra="<p><strong>Note:</strong> Even if <var>ACreate</var> is false the file will be created momentarily. This means that <var>APath</var> must exist and the current user must have write access to the path or the routine will fail.</p>"
10931093
Units=Windows,SysUtils
10941094
SeeAlso=TempFolder,TempFileNameEx
@@ -1112,7 +1112,7 @@ Delphi10S=Y
11121112
FPC=Y
11131113

11141114
[TempFileNameEx]
1115-
DescEx="Returns a unique temporary file name in the directory specified in <var>APath</var>. The file name includes the first three characters of <var>AStub</var> followed by hexadecimal characters. If <var>ACreate</var> is True then the file is created. Returns an empty string on failure."
1115+
DescEx="<p>Returns a unique temporary file name in the directory specified in <var>APath</var>. The file name includes the first three characters of <var>AStub</var> followed by hexadecimal characters.</p><p>If <var>ACreate</var> is True then the file is created. Returns an empty string on failure.</p>"
11161116
Extra="<p><strong>Note:</strong> Even if <var>ACreate</var> is false the file will be created momentarily. This means that <var>APath</var> must exist and the current user must have write access to the path or the routine will fail.</p><p>From Bill Miller's snippets collection.</p>"
11171117
Units=Windows,SysUtils
11181118
SeeAlso=TempFileName

‎csdb/collection/graphics.ini

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# https://gravatar.com/delphidabbler
77

88
[AdjustColorBrightness]
9-
DescEx="Adjusts the brightness of colour <var>Color</var> by a specified <var>Delta</var> in range -255..255."
9+
DescEx="<p>Adjusts the brightness of colour <var>Color</var> by a specified <var>Delta</var> in range -255..255.</p>"
1010
Extra="<p>Based on code found on the former EFG's Delphi Reference Library.</p>"
1111
Units=Windows,Graphics
1212
SeeAlso=AdjustBitmapBrightness
@@ -30,7 +30,7 @@ Delphi10S=Y
3030
FPC=N
3131

3232
[BitmapToMetafile]
33-
DescEx="Converts a bitmap into an extended meta file object. Metafile <var>EMF</var> is updated to contain a copy of bitmap <var>Bmp</var>."
33+
DescEx="<p>Converts a bitmap into an extended meta file object. Metafile <var>EMF</var> is updated to contain a copy of bitmap <var>Bmp</var>.</p>"
3434
Units=Graphics
3535
SeeAlso=GraphicToBitmap
3636
Snip=178.dat
@@ -54,7 +54,7 @@ FPC=N
5454

5555
[CloneCursorAsBitmap]
5656
DescEx="<p>Creates and returns a bitmap object that contains a copy of the given cursor.</p><p>The bitmap has the pixel format specified by <var>PixelFmt</var>. If <var>PixelFmt</var> is <var>pfCustom</var>, then the default format is used.</p><p> <var>TransparentColor</var> specifies the colour in the cursor that is to be drawn as transparent in the bitmap. <var>TransparentColor</var> has no effect if it is <var>clNone</var>.</p>"
57-
Extra="<strong>Note:</strong> The caller is responsible for freeing the bitmap created by this function."
57+
Extra="<p><strong>Note:</strong> The caller is responsible for freeing the bitmap created by this function.</p>"
5858
Units=Controls,Graphics,Forms
5959
Depends=CloneCursorHandleAsBitmap
6060
SeeAlso=CloneCursorHandleAsBitmap,CloneCursorAsBitmap,CloneCursorAsIcon,CloneCursorHandleAsIcon,CursorHandleToBitmap,CursorToBitmap
@@ -79,7 +79,7 @@ FPC=N
7979

8080
[CloneCursorAsIcon]
8181
DescEx="<p>Creates and returns an icon object that contains a copy of the given cursor.</p>"
82-
Extra="<strong>Note:</strong> The caller is responsible for freeing the icon created by this function."
82+
Extra="<p><strong>Note:</strong> The caller is responsible for freeing the icon created by this function.</p>"
8383
Units=Controls,Graphics,Forms
8484
Depends=CloneCursorHandleAsIcon
8585
SeeAlso=CloneCursorAsBitmap,CloneCursorHandleAsBitmap,CloneCursorHandleAsIcon,CursorHandleToBitmap,CursorToBitmap
@@ -104,7 +104,7 @@ FPC=N
104104

105105
[CloneCursorHandleAsBitmap]
106106
DescEx="<p>Creates and returns a bitmap object that contains a copy of the cursor whose handle is given by <var>Handle</var>.</p><p>The bitmap has the pixel format specified by <var>PixelFmt</var>. If <var>PixelFmt</var> is <var>pfCustom</var>, then the default format is used.</p><p><var>TransparentColor</var> specifies the colour in the cursor that is to be drawn as transparent in the bitmap. <var>TransparentColor</var> has no effect if it is <var>clNone</var>.</p>"
107-
Extra="<strong>Note:</strong> The caller is responsible for freeing the bitmap created by this function."
107+
Extra="<p><strong>Note:</strong> The caller is responsible for freeing the bitmap created by this function.</p>"
108108
Units=Windows,Graphics
109109
Depends=CloneGraphicAsBitmap
110110
SeeAlso=CloneCursorAsBitmap,CloneCursorAsIcon,CloneCursorHandleAsIcon,CursorHandleToBitmap,CursorToBitmap
@@ -129,7 +129,7 @@ FPC=N
129129

130130
[CloneCursorHandleAsIcon]
131131
DescEx="<p>Creates and returns an icon object that contains a copy of the cursor with the given handle.</p>"
132-
Extra="<strong>Note:</strong> The caller is responsible for freeing the icon created by this function."
132+
Extra="<p><strong>Note:</strong> The caller is responsible for freeing the icon created by this function.</p>"
133133
Units=Windows,Graphics
134134
SeeAlso=CloneCursorAsBitmap,CloneCursorAsIcon,CloneCursorHandleAsBitmap,CursorHandleToBitmap,CursorToBitmap
135135
Snip=274.dat
@@ -153,7 +153,7 @@ FPC=N
153153

154154
[CloneGraphicAsBitmap]
155155
DescEx="<p>Creates and returns a bitmap object that contains a copy of given graphic object <var>Src</var>.</p><p>The bitmap has the pixel format specified by <var>PixelFmt</var>. If <var>PixelFmt</var> is <var>pfCustom</var>, then the default format is used, unless <var>Src</var> is a bitmap when its own format is used.</p><p>If <var>Src</var> is transparent then the bitmap is set to transparent and <var>TransparentColor</var> is used as the bitmap's transparent colour. <var>TransparentColor</var> is ignored if it is <var>clNone</var> or if <var>Src</var> is not transparent.</p>"
156-
Extra="<strong>Note:</strong> The caller is responsible for freeing the bitmap created by this function."
156+
Extra="<p><strong>Note:</strong> The caller is responsible for freeing the bitmap created by this function.</p>"
157157
Units=Graphics
158158
Depends=GraphicToBitmap
159159
SeeAlso=GraphicToBitmap,CloneJPEGAsBitmap
@@ -178,7 +178,7 @@ FPC=N
178178

179179
[CloneJPEGAsBitmap]
180180
DescEx="<p>Creates and returns a bitmap object that contains a copy of the given JPEG image.</p>"
181-
Extra="<strong>Note:</strong> The caller is responsible for freeing the bitmap created by this function."
181+
Extra="<p><strong>Note:</strong> The caller is responsible for freeing the bitmap created by this function.</p>"
182182
Units=Graphics,JPEG
183183
SeeAlso=JPEGFileToBitmapFile,CloneGraphicAsBitmap
184184
Snip=279.dat
@@ -201,7 +201,7 @@ Delphi10S=Y
201201
FPC=N
202202

203203
[ColorToRGBTriple]
204-
DescEx="Converts the given <var>TColor</var> value into an RGB triple value, which is returned."
204+
DescEx="<p>Converts the given <var>TColor</var> value into an RGB triple value, which is returned.</p>"
205205
Extra="<p>System colours are converted to their actual values before conversion.</p>"
206206
Units=Windows,Graphics
207207
Depends=ExtractRGB
@@ -392,7 +392,7 @@ Delphi10S=Y
392392
FPC=N
393393

394394
[ExtractRGB]
395-
DescEx="Extracts constituent RGB values from the given colour and returns them via the <var>Red</var>, <var>Green</var> and <var>Blue</var> parameters."
395+
DescEx="<p>Extracts constituent RGB values from the given colour and returns them via the <var>Red</var>, <var>Green</var> and <var>Blue</var> parameters.</p>"
396396
Extra="<p>System colours are converted to their actual values before extracting the RGB values.</p>"
397397
Units=Graphics,Windows
398398
SeeAlso=ColorToRGBTriple
@@ -438,7 +438,7 @@ Delphi10S=Y
438438
FPC=N
439439

440440
[GetIconANDBitmask]
441-
DescEx="Copies the given icon's <em>AND</em> bitmask to bitmap <var>Mask</var>."
441+
DescEx="<p>Copies the given icon's <em>AND</em> bitmask to bitmap <var>Mask</var>.</p>"
442442
Units=Graphics,Windows,SysUtils
443443
SeeAlso=IsCursorIcon,IsColorIcon,GetIconHotspot,GetIconXORBitmask
444444
Snip=116.dat
@@ -461,7 +461,7 @@ Delphi10S=Y
461461
FPC=N
462462

463463
[GetIconXORBitmask]
464-
DescEx="Copies the given icon's <em>XOR</em> bitmask to bitmap <var>Mask</var>."
464+
DescEx="<p>Copies the given icon's <em>XOR</em> bitmask to bitmap <var>Mask</var>.</p>"
465465
Units=Graphics,Windows,SysUtils,Classes
466466
SeeAlso=IsCursorIcon,IsColorIcon,GetIconHotspot,GetIconANDBitmask
467467
Snip=117.dat
@@ -671,7 +671,7 @@ Delphi10S=Y
671671
FPC=N
672672

673673
[RGBTripleToColor]
674-
DescEx="Converts an RGB triple value into a <var>TColor</var> value."
674+
DescEx="<p>Converts an RGB triple value into a <var>TColor</var> value.</p>"
675675
Units=Windows,Graphics
676676
SeeAlso=ColorToRGBTriple
677677
Snip=096.dat
@@ -694,7 +694,7 @@ Delphi10S=Y
694694
FPC=N
695695

696696
[SetDefaultFont]
697-
DescEx="Sets the given <var>TFont</var> object to the default GUI font for the operating system."
697+
DescEx="<p>Sets the given <var>TFont</var> object to the default GUI font for the operating system.</p>"
698698
Extra="<p>From Bill Miller's snippets collection.</p>"
699699
Units=Windows,Graphics
700700
SeeAlso=SetDesktopIconFont
@@ -815,7 +815,7 @@ Delphi10S=Y
815815
FPC=N
816816

817817
[AdjustBitmapBrightness]
818-
DescEx="Changes the brightness of bitmap <var>Bmp</var> by a given <var>Delta</var> value in range -255..+255."
818+
DescEx="<p>Changes the brightness of bitmap <var>Bmp</var> by a given <var>Delta</var> value in range -255..+255.</p>"
819819
Extra="<p>Based on code found on the former EFG's Delphi Reference Library.</p> <p><strong>Note from EFG:</strong> Normally a <var>pf24bit</var> bitmap scanline would be accessed as a type <mono>TRGBTripleArray = array[Word] of TRGBTriple</mono>, but since we can treat the three color components (<var>rgbtRed</var>, <var>rgbtGreen</var>, <var>rgbtBlue</var>) in exactly the same way, we can access the scanline as a <var>pByteArray</var> of <mono>3 * Bitmap.Width</mono> bytes.</p>"
820820
Units=SysUtils,Graphics
821821
SeeAlso=AdjustColorBrightness
@@ -917,7 +917,7 @@ Delphi10S=Y
917917
FPC=N
918918

919919
[ColorToHSB]
920-
DescEx="Converts the given <var>TColor</var> value to a <var>THSBColor</var> value, which is returned."
920+
DescEx="<p>Converts the given <var>TColor</var> value to a <var>THSBColor</var> value, which is returned.</p>"
921921
Extra="<p>System colours are converted to their actual values before conversion.</p>"
922922
Units=Graphics
923923
Depends=THSBColor,ColorToRGBTriple,RGBToHSB
@@ -1453,7 +1453,7 @@ FPC=N
14531453

14541454
[ScaleBitmap_A]
14551455
DisplayName="ScaleBitmap (copy overload)"
1456-
DescEx="Performs a high quality scaling of bitmap <var>ASrcBmp</var> and copies the result into <var>ADestBmp</var>. The required scale factor is given by <var>AScaling</var>."
1456+
DescEx="<p>Performs a high quality scaling of bitmap <var>ASrcBmp</var> and copies the result into <var>ADestBmp</var>. The required scale factor is given by <var>AScaling</var>.</p>"
14571457
Extra="<p>Modified from code contributed by Montor.</p>"
14581458
Units=Graphics,Types
14591459
Depends=ScaleRect,RectWidth,RectHeight,HalftoneStretch_A
@@ -1479,7 +1479,7 @@ FPC=N
14791479

14801480
[ScaleBitmap_B]
14811481
DisplayName="ScaleBitmap (inplace overload)"
1482-
DescEx="Performs a high quality scaling of the given bitmap by scale factor <var>AScaling</var>. The bitmap is modified in place."
1482+
DescEx="<p>Performs a high quality scaling of the given bitmap by scale factor <var>AScaling</var>. The bitmap is modified in place.</p>"
14831483
Extra="<p>Slightly modified from code contributed by Montor.</p>"
14841484
Units=Graphics
14851485
Depends=ScaleBitmap_A
@@ -1579,7 +1579,7 @@ FPC=Y
15791579

15801580
[TColorRec]
15811581
Kind=type
1582-
DescEx="Cracker record that provides several different views of a <var>TColor</var> value and allows it to be assembled from its constituent parts."
1582+
DescEx="<p>Cracker record that provides several different views of a <var>TColor</var> value and allows it to be assembled from its constituent parts.</p>"
15831583
Extra="<p>Contributed by Montor.</p> <p><strong>Note:</strong> Care needs to be taken when using <var>SysFlag</var> to detect a system colour, because <var>SysFlag</var> will be equal to $FF if a normal colour has an alpha transparency of $FF.</p>"
15841584
Snip=375.dat
15851585
Delphi2=Y

‎csdb/collection/hex.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ FPC=Y
201201

202202
[TryHexToInt64]
203203
DescEx="<p>Attempts to convert the given hexadecimal string into a 64 bit integer.</p><p>Returns True on success and set <var>Value</var> to the converted value. Returns False on error, leaving <var>Value</var> undefined.</p>"
204-
Extra="</p>The hexadecimal string must contain only valid hex digits, optionally prefixed by either '$' or '0x'.</p>"
204+
Extra="<p>The hexadecimal string must contain only valid hex digits, optionally prefixed by either '$' or '0x'.</p>"
205205
Depends=AddHexPrefix
206206
SeeAlso=HexToInt64,HexToInt64Def,TryHexToBuf,TryHexToInt
207207
TestInfo=advanced

0 commit comments

Comments
 (0)