]> git.ipfire.org Git - thirdparty/squid.git/blobdiff - compat/compat.dox
Source Format Enforcement (#532)
[thirdparty/squid.git] / compat / compat.dox
index 29e75f3fdd20df2ade155282ea36cfcdd410bf75..99fabf02c54048166f27686e14eaa9a8995826c7 100644 (file)
@@ -1,3 +1,11 @@
+/*
+ * Copyright (C) 1996-2020 The Squid Software Foundation and contributors
+ *
+ * Squid software is distributed under GPLv2+ license and includes
+ * contributions from numerous individuals and organizations.
+ * Please see the COPYING and CONTRIBUTORS files for details.
+ */
+
 /**
 \defgroup compat Portability Library
 
@@ -14,7 +22,7 @@ some older hacks, and some cases of obsolete algorithms sitting side by side wit
 current equivalent.
 
 \par
-The Portability library libcompat-squid.la has been created to correct the three issues of
+The Portability library libcompatsquid.la has been created to correct the three issues of
 stable build portability, code cleanliness, and clearer licensing.
 
 
@@ -30,7 +38,7 @@ But they are required to meet several other criteria:
       available to be included with the Squid sources and used when required.
 
 \par
-To be built into the libcompat-squid.la as a layer below all Squid-bundled binaries. The
+To be built into the libcompatsquid.la as a layer below all Squid-bundled binaries. The
 code must also qualify by being provided natively by some OS where Squid builds. \br
 Code and Algorithms which do not meet this final criteria are relegated to the slightly
 higher level of basic component, rather than portability.
@@ -63,7 +71,7 @@ handling and memory allocation.
 
 
 \section sec4 Layout
-The internal code structure of libcompat-squid.la files has a hierarchy. The API has a flat
+The internal code structure of libcompatsquid.la files has a hierarchy. The API has a flat
 global scope separate from the file layout. The API is pulled in by including compat/compat.h.
 The strict dependency requirements which exist within the compat API make including an
 individual part separately a risky operation.