Add header comments to every .ini file

delphidabbler · delphidabbler · commit 674f2bed1e1d · 2020-05-01T02:30:30.000+01:00
diff --git a/csdb/collection/arrays.ini b/csdb/collection/arrays.ini
@@ -1,4 +1,11 @@
-﻿[ArrayToStringList]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Arrays category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[ArrayToStringList]
 DescEx="<p>Copies the elements of string array <var>Strings</var> to string list <var>SL</var>, replacing any existing contents of <var>SL</var>.</p>"
 SeeAlso=StringListToArray
 Units=Classes
diff --git a/csdb/collection/categories.ini b/csdb/collection/categories.ini
@@ -1,4 +1,11 @@
-﻿[arrays]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Master categories file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[arrays]
 Desc=Arrays
 Ini=arrays.ini
 
diff --git a/csdb/collection/consts.ini b/csdb/collection/consts.ini
@@ -1,4 +1,11 @@
-﻿[SHIL_Enum]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Constants category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[SHIL_Enum]
 Kind=const
 DisplayName=SHIL_* Constants
 DescEx="Constants that can be passed as flags to specify the required image type in calls to the <var>SysImageListHandleEx</var> routine."
diff --git a/csdb/collection/date.ini b/csdb/collection/date.ini
@@ -1,4 +1,11 @@
-﻿[AddDays]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Date and Time category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[AddDays]
 DescEx="<p>Adds the number of days, <var>Days</var>, to the given date, <var>DateTime</var> and returns the result.</p><p>To subtract days, pass a negative value for <var>Days</var>.</p>"
 Credits="Contributed by Bill Miller."
 SeeAlso=DiffDays
diff --git a/csdb/collection/drive.ini b/csdb/collection/drive.ini
@@ -1,4 +1,11 @@
-﻿[CurentDrive]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Drive Management category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[CurentDrive]
 Desc="Returns the letter that identifies the current drive."
 Credits="Modified from Bill Miller's snippets collection."
 Snip=352.dat
diff --git a/csdb/collection/encoding.ini b/csdb/collection/encoding.ini
@@ -1,4 +1,11 @@
-﻿[BytesToAnsiString]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Encoding category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[BytesToAnsiString]
 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>."
 Credits="Based on code from the Stack Overflow posting [How can I convert TBytes to RawByteString?]."
 Credits_URL="http://stackoverflow.com/questions/773297/how-can-i-convert-tbytes-to-rawbytestring"
diff --git a/csdb/collection/file.ini b/csdb/collection/file.ini
@@ -1,4 +1,11 @@
-﻿[CopyFile]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# File Management category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[CopyFile]
 DescEx="Copies <var>Source</var> file to <var>Dest</var> file, preserving modification date."
 Units=Classes,SysUtils
 SeeAlso=CopyFiles
diff --git a/csdb/collection/graphics.ini b/csdb/collection/graphics.ini
@@ -1,4 +1,11 @@
-﻿[AdjustColorBrightness]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Graphics category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[AdjustColorBrightness]
 DescEx="Adjusts the brightness of colour <var>Color</var> by a specified <var>Delta</var> in range -255..255."
 Credits="Based on code found on the former EFG's Delphi Reference Library."
 Units=Windows,Graphics
diff --git a/csdb/collection/hex.ini b/csdb/collection/hex.ini
@@ -1,4 +1,11 @@
-﻿[AddHexPrefix]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Hex Utilities category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[AddHexPrefix]
 Desc="Adds a valid hex prefix to the given string of hex digits."
 Comments="The hex prefix is '$' when compiled on Delphi or '0x' when compiled on C++ Builder."
 Units=SysUtils
diff --git a/csdb/collection/io.ini b/csdb/collection/io.ini
@@ -1,4 +1,11 @@
-﻿[FileToString]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# File and Stream I/O category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[FileToString]
 DescEx="Reads text in the default ANSI encoding from file named by <var>FileName</var> into a string, which is returned."
 Units=Classes,SysUtils
 Depends=StreamToString
diff --git a/csdb/collection/maths.ini b/csdb/collection/maths.ini
@@ -1,4 +1,11 @@
-﻿[AllDigitsDifferent]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Mathematics category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[AllDigitsDifferent]
 Desc="Checks if all the digits of the given integer are different to each other."
 Comments="An example of an integer with all digits different is 15862."
 SeeAlso=AllDigitsSame
diff --git a/csdb/collection/multimedia.ini b/csdb/collection/multimedia.ini
@@ -1,4 +1,11 @@
-﻿[PlaySound]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Multi Media category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[PlaySound]
 Desc="Plays sound from the given wave (.wav) file asynchronously."
 Credits="From Bill Miller's snippets collection."
 Units=MMSystem
diff --git a/csdb/collection/registry.ini b/csdb/collection/registry.ini
@@ -1,4 +1,11 @@
-﻿[GetRegistryString]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Registry category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[GetRegistryString]
 DescEx="<p>Reads and returns the value named by <var>Name</var> from the registry sub-key <var>SubKey</var> in root key <var>RootKey</var>.</p><p>String, expanded string and integer value types are all handled, with integer values being converted to strings. Other values types are not supported and cause an exception to be raised.</p><p>The empty string is returned if the named value does not exist.</p>"
 Units=Windows,SysUtils,Registry
 Snip=067.dat
diff --git a/csdb/collection/shell.ini b/csdb/collection/shell.ini
@@ -1,4 +1,11 @@
-﻿[AddToRecentDocs]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Windows Shell category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[AddToRecentDocs]
 Desc="Adds the given file to the Recent Documents folder."
 Units=ShlObj
 SeeAlso=ClearRecentDocs
diff --git a/csdb/collection/string.ini b/csdb/collection/string.ini
@@ -1,4 +1,11 @@
-﻿[AddThousandSeparator]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# String Management category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[AddThousandSeparator]
 DescEx="<p>Adds the &quot;thousands separator&quot; specified by <var>C</var> at the correct location(s) in string <var>S</var> and returns the result.</p><p><var>S</var> is assumed to be the string representation of a positive whole number.</p>"
 Credits="Contributed by Bill Miller."
 SeeAlso=AddDefThousandSeparator
diff --git a/csdb/collection/structs.ini b/csdb/collection/structs.ini
@@ -1,4 +1,11 @@
-﻿[BoundsF]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Structures category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[BoundsF]
 DescEx="Constructs and returns a <var>TRectF</var> record with the given top-left coordinate, width and height."
 SeeAlso=RectF,TRectF
 Depends=TRectF
diff --git a/csdb/collection/sys.ini b/csdb/collection/sys.ini
@@ -1,4 +1,11 @@
-﻿[DebuggerPresent]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# System category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[DebuggerPresent]
 Desc="Indicates whether the calling process is running within a debugger."
 Credits="Contributed by DennisLV."
 Units=Windows
diff --git a/csdb/collection/types.ini b/csdb/collection/types.ini
@@ -1,4 +1,11 @@
-﻿[RawByteString]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Types category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[RawByteString]
 Kind=type
 DescEx="Definition of <var>RawByteString</var> type for non-Unicode compilers."
 Extra="<p><strong>Note:</strong> This type is defined in the <var>System</var> unit on Unicode compilers.</p>"
diff --git a/csdb/collection/utils.ini b/csdb/collection/utils.ini
@@ -1,4 +1,11 @@
-﻿[BytesToGB]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Utilities category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[BytesToGB]
 Desc="Converts the given number of bytes to gigabytes."
 SeeAlso=BytesToGBStr,BytesToKB,BytesToMB
 Snip=295.dat
diff --git a/csdb/collection/wb.ini b/csdb/collection/wb.ini
@@ -1,4 +1,11 @@
-﻿[WBAppendHTML]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# TWebBrowser category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[WBAppendHTML]
 DescEx="<p>Appends the given HTML to the end of the given web browser control's current document body.</p><p>Does nothing if no document is loaded, if the document does not support the DOM, or if the document is a frameset.</p>"
 Extra="<p>Developed from code submitted by Bill Miller.</p>"
 Units=SysUtils,SHDocVw,MSHTML
diff --git a/csdb/collection/web.ini b/csdb/collection/web.ini
@@ -1,4 +1,11 @@
-﻿[BrowseURL]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Internet category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[BrowseURL]
 DescEx="<p>Activates the default browser or email client for a given URL. Returns True if the browser/email client is successfully launched and False if not.</p><p>Raises an exception if the URL doesn't conform to a known protocol.</p>"
 Units=SysUtils
 Depends=IsValidURLProtocol,ExecAssociatedApp
diff --git a/csdb/collection/windows.ini b/csdb/collection/windows.ini
@@ -1,4 +1,11 @@
-﻿[ClientRectToScreen]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Windows category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[ClientRectToScreen]
 DescEx="Translates the rectangle <var>CliRect</var>, which has coordinates relative to the client area of control <var>Ctrl</var>, into global screen coordinates and returns the result."
 Units=Controls,Windows
 SeeAlso=CtrlBoundsToScreen
diff --git a/csdb/collection/winsys.ini b/csdb/collection/winsys.ini
@@ -1,4 +1,11 @@
-﻿[CommonFilesFolder]
+﻿# DelphiDabbler Code Snippets Database v2
+#
+# Windows System category file
+#
+# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
+# https://gravatar.com/delphidabbler
+
+[CommonFilesFolder]
 Desc="Returns the Windows common files directory."
 Depends=GetCurrentVersionRegStr
 SeeAlso=ProgramFilesFolder,SystemFolder,TempFolder,WindowsFolder,GetDesktopFolder
