LazUtils: Add, fix and unify header comments of many units.

git-svn-id: trunk@52518 -
2025-06-01 23:12:42 +02:00 · 2016-06-18 16:40:04 +00:00 · 2016-06-18 16:40:04 +00:00 · 920c072f0e
commit 920c072f0e
parent 801f392c8d
46 changed files with 245 additions and 122 deletions
--- a/components/lazutils/asiancodepagefunctions.inc
+++ b/components/lazutils/asiancodepagefunctions.inc
@ -1,16 +1,14 @@
 {%MainUnit ../lconvencoding.pp}

-{******************************************************************************
-                               Asian Unicode Functions
- ******************************************************************************
-
+{
 *****************************************************************************
-  This file is part of the Lazarus Component Library (LCL)
+  This file is part of LazUtils.

  See the file COPYING.modifiedLGPL.txt, included in this distribution,
  for details about the license.
 *****************************************************************************

+  Asian Unicode Functions.
  The clipboard is able to work with the windows and gtk behaviour/features.
 }

--- a/components/lazutils/asiancodepages.inc
+++ b/components/lazutils/asiancodepages.inc
@ -1,15 +1,14 @@
 {%MainUnit ../lconvencoding.pp}

-{******************************************************************************
-                         Asian Unicode Conversion Tables
- ******************************************************************************
-
+{
 *****************************************************************************
-  This file is part of the Lazarus Component Library (LCL)
+  This file is part of LazUtils.

  See the file COPYING.modifiedLGPL.txt, included in this distribution,
  for details about the license.
 *****************************************************************************
+
+  Asian Unicode Conversion Tables
 }
 type  
 CP936Arr = array[0..22046] of word;
--- a/components/lazutils/avglvltree.pas
+++ b/components/lazutils/avglvltree.pas
@ -1,6 +1,6 @@
 {
 *****************************************************************************
-  This file is part of the Lazarus Component Library (LCL)
+  This file is part of LazUtils.

  See the file COPYING.modifiedLGPL.txt, included in this distribution,
  for details about the license.
--- a/components/lazutils/easylazfreetype.pas
+++ b/components/lazutils/easylazfreetype.pas
@ -1,17 +1,25 @@
+{
+ *****************************************************************************
+  This file is part of LazUtils.
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ *****************************************************************************
+
+  Bug list :
+
+ - Characters parts may not be well translated, for example i with accent.
+ - Encoding is ok for ASCII but is mixed up for extended characters
+
+ to do :
+
+ - multiple font loading
+ - font face cache
+ - font style
+ - text rotation
+}
 unit EasyLazFreeType;

-{ bug list :
-
- Characters parts may not be well translated, for example i with accent.
- Encoding is ok for ASCII but is mixed up for extended characters
-
-to do :
-
- multiple font loading
- font face cache
- font style
- text rotation }
-
 {$mode objfpc}{$H+}

 interface
--- a/components/lazutils/fileutil.pas
+++ b/components/lazutils/fileutil.pas
@ -1,12 +1,6 @@
 {
- /***************************************************************************
-                               fileutil.pas
-                               ------------
-
- ***************************************************************************/
-
 *****************************************************************************
-  This file is part of the LazUtils package.
+  This file is part of LazUtils.

  See the file COPYING.modifiedLGPL.txt, included in this distribution,
  for details about the license.
--- a/components/lazutils/fpcadds.pas
+++ b/components/lazutils/fpcadds.pas
@ -1,12 +1,6 @@
 {
- /***************************************************************************
-                                FPCAdds.pas
-                                -----------
-
- ***************************************************************************/
-
 *****************************************************************************
-  This file is part of the Lazarus Component Library (LCL)
+  This file is part of LazUtils.

  See the file COPYING.modifiedLGPL.txt, included in this distribution,
  for details about the license.
--- a/components/lazutils/laz2_dom.pas
+++ b/components/lazutils/laz2_dom.pas
@ -1,10 +1,8 @@
-{
-  This file is based on the FCL unit dom svn revision 15251.
-  Converted to use UTF8 instead of widestrings by Mattias Gaertner.
-}
 {
 **********************************************************************
-  This file is part of the Free Component Library
+  This file is part of LazUtils.
+  It is copied from FCL unit dom svn revision 15251 and adapted to use
+  UTF8 instead of widestrings by Mattias Gaertner.

  See the file COPYING.FPC, included in this distribution,
  for details about the license.
--- a/components/lazutils/laz2_names.inc
+++ b/components/lazutils/laz2_names.inc
@ -1,6 +1,7 @@
 {
 **********************************************************************
-  This file is part of the Free Component Library
+  This file is part of LazUtils.
+  It is copied and modified from a file in Free Component Library.

  See the file COPYING.FPC, included in this distribution,
  for details about the license.
--- a/components/lazutils/laz2_xmlcfg.pas
+++ b/components/lazutils/laz2_xmlcfg.pas
@ -1,6 +1,8 @@
 {
-  This file was part of the Free Component Library and was adapted to use UTF8
-  strings instead of widestrings.
+ **********************************************************************
+  This file is part of LazUtils.
+  It is copied from Free Component Library and adapted to use
+  UTF8 strings instead of widestrings.

  See the file COPYING.modifiedLGPL.txt, included in this distribution,
  for details about the license.
--- a/components/lazutils/laz2_xmlread.pas
+++ b/components/lazutils/laz2_xmlread.pas
@ -1,10 +1,8 @@
-{
-  This file is based on the FCL unit xmlread svn revision 15251.
-  Converted to use UTF8 instead of widestrings by Mattias Gaertner.
-}
 {
 **********************************************************************
-  This file is part of the Free Component Library
+  This file is part of LazUtils.
+  It is copied from FCL unit xmlread svn revision 15251 and adapted to use
+  UTF8 instead of widestrings by Mattias Gaertner.

  See the file COPYING.FPC, included in this distribution,
  for details about the license.
--- a/components/lazutils/laz2_xmlutils.pas
+++ b/components/lazutils/laz2_xmlutils.pas
@ -1,6 +1,7 @@
 {
 **********************************************************************
-  This file is part of the Free Component Library
+  This file is part of LazUtils.
+  It is copied and modified from a file in Free Component Library.

  See the file COPYING.FPC, included in this distribution,
  for details about the license.
--- a/components/lazutils/laz2_xmlwrite.pas
+++ b/components/lazutils/laz2_xmlwrite.pas
@ -1,6 +1,7 @@
 {
 **********************************************************************
-  This file is based on the FCL unit xmlwrite svn revision 15251.
+  This file is part of LazUtils.
+  It is based on the FCL unit xmlwrite svn revision 15251.

  See the file COPYING.FPC, included in this distribution,
  for details about the license.
--- a/components/lazutils/laz2_xpath.pas
+++ b/components/lazutils/laz2_xpath.pas
@ -1,6 +1,7 @@
 {
 **********************************************************************
-  This file is based on the xpath unit of the Free Component Library.
+  This file is part of LazUtils.
+  It is based on the xpath unit of the Free Component Library.

  See the file COPYING.FPC, included in this distribution,
  for details about the license.
--- a/components/lazutils/laz_dom.pas
+++ b/components/lazutils/laz_dom.pas
@ -1,3 +1,14 @@
+{
+ **********************************************************************
+  This file is part of LazUtils.
+  It is copied from Free Component Library.
+
+  See the file COPYING.FPC, included in this distribution,
+  for details about the license.
+ **********************************************************************
+
+}
+
 unit Laz_DOM;

 {$MODE objfpc}{$H+}
--- a/components/lazutils/laz_xmlcfg.pas
+++ b/components/lazutils/laz_xmlcfg.pas
@ -1,7 +1,8 @@
 {
 **********************************************************************
-  This file was part of the Free Component Library and was adapted to use UTF8
-  strings instead of widestrings.
+  This file is part of LazUtils.
+  It is copied from Free Component Library and was adapted to use
+  UTF8 strings instead of widestrings.

  See the file COPYING.modifiedLGPL.txt, included in this distribution,
  for details about the license.
--- a/components/lazutils/laz_xmlread.pas
+++ b/components/lazutils/laz_xmlread.pas
@ -1,3 +1,14 @@
+{
+ **********************************************************************
+  This file is part of LazUtils.
+  It is copied from Free Component Library.
+
+  See the file COPYING.FPC, included in this distribution,
+  for details about the license.
+ **********************************************************************
+
+}
+
 unit Laz_XMLRead;

 {$MODE objfpc}{$H+}
--- a/components/lazutils/laz_xmlstreaming.pas
+++ b/components/lazutils/laz_xmlstreaming.pas
@ -1,9 +1,10 @@
 {
 **********************************************************************
-    This file is part of the Free Component Library
+  This file is part of LazUtils.
+  It is copied from Free Component Library.

-    See the file COPYING.FPC, included in this distribution,
-    for details about the license.
+  See the file COPYING.FPC, included in this distribution,
+  for details about the license.
 **********************************************************************

  XML serialisation driver
--- a/components/lazutils/laz_xmlwrite.pas
+++ b/components/lazutils/laz_xmlwrite.pas
@ -1,3 +1,14 @@
+{
+ **********************************************************************
+  This file is part of LazUtils.
+  It is copied from Free Component Library.
+
+  See the file COPYING.FPC, included in this distribution,
+  for details about the license.
+ **********************************************************************
+
+}
+
 unit Laz_XMLWrite;

 {$MODE objfpc}{$H+}
--- a/components/lazutils/lazclasses.pas
+++ b/components/lazutils/lazclasses.pas
@ -1,3 +1,11 @@
+{
+ *****************************************************************************
+  This file is part of LazUtils.
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ *****************************************************************************
+}
 unit LazClasses;

 {$mode objfpc}{$H+}
--- a/components/lazutils/lazcollections.pas
+++ b/components/lazutils/lazcollections.pas
@ -1,3 +1,11 @@
+{
+ *****************************************************************************
+  This file is part of LazUtils.
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ *****************************************************************************
+}
 unit lazCollections;

 {$mode objfpc}{$H+}
--- a/components/lazutils/lazconfigstorage.pas
+++ b/components/lazutils/lazconfigstorage.pas
@ -1,5 +1,7 @@
 {
 *****************************************************************************
+  This file is part of LazUtils.
+
  See the file COPYING.modifiedLGPL.txt, included in this distribution,
  for details about the license.
 *****************************************************************************
--- a/components/lazutils/lazdbglog.pas
+++ b/components/lazutils/lazdbglog.pas
@ -1,3 +1,11 @@
+{
+ **********************************************************************
+  This file is part of LazUtils.
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ **********************************************************************
+}
 unit LazDbgLog;

 {$mode objfpc}{$H+}
--- a/components/lazutils/lazfglhash.pas
+++ b/components/lazutils/lazfglhash.pas
@ -1,3 +1,11 @@
+{
+ *****************************************************************************
+  This file is part of LazUtils.
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ *****************************************************************************
+}
 unit lazfglhash;

 {$mode objfpc}{$H+}
--- a/components/lazutils/lazfilecache.pas
+++ b/components/lazutils/lazfilecache.pas
@ -1,3 +1,11 @@
+{
+ **********************************************************************
+  This file is part of LazUtils.
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ **********************************************************************
+}
 unit LazFileCache;

 {$mode objfpc}{$H+}
--- a/components/lazutils/lazfileutils.pas
+++ b/components/lazutils/lazfileutils.pas
@ -1,5 +1,11 @@
 {
+ **********************************************************************
+  This file is part of LazUtils.
  All functions are thread safe unless explicitely stated
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ **********************************************************************
 }
 unit LazFileUtils;

--- a/components/lazutils/lazfreetypefontcollection.pas
+++ b/components/lazutils/lazfreetypefontcollection.pas
@ -1,3 +1,11 @@
+{
+ *****************************************************************************
+  This file is part of LazUtils.
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ *****************************************************************************
+}
 unit LazFreeTypeFontCollection;

 {$mode objfpc}{$H+}
--- a/components/lazutils/lazfreetypefpimagedrawer.pas
+++ b/components/lazutils/lazfreetypefpimagedrawer.pas
@ -1,3 +1,11 @@
+{
+ *****************************************************************************
+  This file is part of LazUtils.
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ *****************************************************************************
+}
 unit LazFreeTypeFPImageDrawer;

 {$mode objfpc}{$H+}
--- a/components/lazutils/lazlistclasses.pas
+++ b/components/lazutils/lazlistclasses.pas
@ -1,18 +1,12 @@
 {
- /***************************************************************************
-                               LazListClasses.pas
-                               ---------------
-                   Initial Revision  : May 2015
-
-
- ***************************************************************************/
-
 *****************************************************************************
-  This file is part of the Lazarus Component Library (LCL)
+  This file is part of LazUtils.

  See the file COPYING.modifiedLGPL.txt, included in this distribution,
  for details about the license.
 *****************************************************************************
+
+ Initial Revision  : May 2015
 }

 unit LazListClasses;
--- a/components/lazutils/lazlogger.pas
+++ b/components/lazutils/lazlogger.pas
@ -1,4 +1,13 @@
+{
+ *****************************************************************************
+  This file is part of LazUtils.
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ *****************************************************************************
+}
 unit LazLogger;
+
 {$mode objfpc}{$H+}

 interface
--- a/components/lazutils/lazloggerbase.pas
+++ b/components/lazutils/lazloggerbase.pas
@ -1,4 +1,13 @@
+{
+ *****************************************************************************
+  This file is part of LazUtils.
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ *****************************************************************************
+}
 unit LazLoggerBase;
+
 {$mode objfpc}{$H+}

 (*
--- a/components/lazutils/lazloggerdummy.pas
+++ b/components/lazutils/lazloggerdummy.pas
@ -1,3 +1,11 @@
+{
+ *****************************************************************************
+  This file is part of LazUtils.
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ *****************************************************************************
+}
 unit LazLoggerDummy;

 {$mode objfpc}{$H+}
--- a/components/lazutils/lazloggerprofiling.pas
+++ b/components/lazutils/lazloggerprofiling.pas
@ -1,3 +1,11 @@
+{
+ *****************************************************************************
+  This file is part of LazUtils.
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ *****************************************************************************
+}
 unit LazLoggerProfiling;

 {$mode objfpc}{$H+}
--- a/components/lazutils/lazmethodlist.pas
+++ b/components/lazutils/lazmethodlist.pas
@ -1,3 +1,11 @@
+{
+ *****************************************************************************
+  This file is part of LazUtils.
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ *****************************************************************************
+}
 unit LazMethodList;

 {$mode objfpc}{$H+}
--- a/components/lazutils/lazutf16.pas
+++ b/components/lazutils/lazutf16.pas
@ -1,10 +1,6 @@
 {
- /***************************************************************************
-                                  lazutf16.pas
- ***************************************************************************/
-
 *****************************************************************************
-  This file is part of LazUtils
+  This file is part of LazUtils.

  See the file COPYING.modifiedLGPL.txt, included in this distribution,
  for details about the license.
@ -14,11 +10,10 @@
  although it might also include routines for other encodings.

  A UTF-16 based implementation for LowerCase, for example, is faster in WideString
-  and UnicodeString then the default UTF-8 implementation
+  and UnicodeString then the default UTF-8 implementation.

  Currently this unit includes only UTF8LowerCaseViaTables which is based on a
-  UTF-16 table, but it might be extended to include various UTF-16 routines
-
+  UTF-16 table, but it might be extended to include various UTF-16 routines.
 }
 unit lazutf16;

--- a/components/lazutils/lazutf8classes.pas
+++ b/components/lazutils/lazutf8classes.pas
@ -1,3 +1,11 @@
+{
+ **********************************************************************
+  This file is part of LazUtils.
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ **********************************************************************
+}
 unit LazUTF8Classes;

 {$mode objfpc}{$H+}
--- a/components/lazutils/lazutf8sysutils.pas
+++ b/components/lazutils/lazutf8sysutils.pas
@ -1,3 +1,11 @@
+{
+ *****************************************************************************
+  This file is part of LazUtils.
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ *****************************************************************************
+}
 unit LazUTF8SysUtils;

 {$mode objfpc}{$H+}
--- a/components/lazutils/lazutilities.pas
+++ b/components/lazutils/lazutilities.pas
@ -1,3 +1,11 @@
+{
+ *****************************************************************************
+  This file is part of LazUtils.
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ *****************************************************************************
+}
 unit LazUtilities;

 {$mode objfpc}{$H+}
--- a/components/lazutils/lazutilsstrconsts.pas
+++ b/components/lazutils/lazutilsstrconsts.pas
@ -1,18 +1,12 @@
 {
- /***************************************************************************
-                            LazUtilsStrConsts.pas
-                            ----------------
-     This unit contains all resource strings from LazUtils
-
-
- ***************************************************************************/
-
 *****************************************************************************
-  This file is part of the Lazarus Component Library (LCL)
+  This file is part of LazUtils.

  See the file COPYING.modifiedLGPL.txt, included in this distribution,
  for details about the license.
 *****************************************************************************
+
+  This unit contains all resource strings from LazUtils.
 }
 unit LazUtilsStrConsts;

--- a/components/lazutils/lconvencoding.pas
+++ b/components/lazutils/lconvencoding.pas
@ -1,6 +1,6 @@
 {
 *****************************************************************************
-  This file is part of the Lazarus Component Library (LCL)
+  This file is part of LazUtils.

  See the file COPYING.modifiedLGPL.txt, included in this distribution,
  for details about the license.
--- a/components/lazutils/lcsvutils.pas
+++ b/components/lazutils/lcsvutils.pas
@ -1,3 +1,11 @@
+{
+ *****************************************************************************
+  This file is part of LazUtils.
+
+  See the file COPYING.modifiedLGPL.txt, included in this distribution,
+  for details about the license.
+ *****************************************************************************
+}
 unit lcsvutils;

 {$mode objfpc}{$H+}
--- a/components/lazutils/lookupstringlist.pas
+++ b/components/lazutils/lookupstringlist.pas
@ -1,6 +1,6 @@
 {
 *****************************************************************************
-  This file is part of the Lazarus Component Library (LCL)
+  This file is part of LazUtils.

  See the file COPYING.modifiedLGPL.txt, included in this distribution,
  for details about the license.
--- a/components/lazutils/masks.pas
+++ b/components/lazutils/masks.pas
@ -1,12 +1,6 @@
 {
- /***************************************************************************
-                                  masks.pas
-                                  ---------
-
- ***************************************************************************/
-
 *****************************************************************************
-  This file is part of the Lazarus Component Library (LCL)
+  This file is part of LazUtils.

  See the file COPYING.modifiedLGPL.txt, included in this distribution,
  for details about the license.
--- a/components/lazutils/paswstring.pas
+++ b/components/lazutils/paswstring.pas
@ -1,16 +1,13 @@
 {
 *****************************************************************************
-                                paswstring.pas
-
-  A widestring manager written in Pascal
-  and optimized for DefaultSystemCodePage CP_UTF8.
-
- *****************************************************************************
-  This file is part of the LazUtils package
+  This file is part of LazUtils.

  See the file COPYING.modifiedLGPL.txt, included in this distribution,
  for details about the license.
 *****************************************************************************
+
+  A widestring manager written in Pascal
+  and optimized for DefaultSystemCodePage CP_UTF8.
 }
 unit PasWString;

--- a/components/lazutils/ttcache.pas
+++ b/components/lazutils/ttcache.pas
@ -50,17 +50,6 @@
 *      zero its main fields (essentially the pointers and array
 *      sizes found in the root fields).
 *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
 ******************************************************************)

 unit TTCache;
--- a/components/lazutils/utf8process.pp
+++ b/components/lazutils/utf8process.pp
@ -1,18 +1,12 @@
 {
- /***************************************************************************
-                               UTF8Process.pp
-                               ---------------
-                   Initial Revision  : Tue Dec 06 09:00:00 CET 2005
-
-
- ***************************************************************************/
-
 *****************************************************************************
-  This file is part of the Lazarus Component Library (LCL)
+  This file is part of LazUtils.

  See the file COPYING.modifiedLGPL.txt, included in this distribution,
  for details about the license.
 *****************************************************************************
+
+ Initial Revision  : Tue Dec 06 09:00:00 CET 2005
 }

 unit UTF8Process;
--- a/components/lazutils/winlazfileutils.inc
+++ b/components/lazutils/winlazfileutils.inc
@ -1,7 +1,6 @@
 {%MainUnit lazfileutils.pas}


-
 function ReadAllLinks(const Filename: string;
                      ExceptionOnError: boolean): string;
 begin
@ -17,7 +16,6 @@ begin
 end;


-
 // ******** Start of WideString specific implementations ************

 const