Cleanup bdl (#4824)

bloomberg · Jul 11, 2024 · 7d2e565 · 7d2e565
1 parent 73c22d1
commit 7d2e565
Show file tree

Hide file tree

Showing 60 changed files with 179 additions and 643 deletions.
diff --git a/groups/bdl/bdlat/bdlat_arrayfunctions.cpp b/groups/bdl/bdlat/bdlat_arrayfunctions.cpp
@@ -1,12 +1,4 @@
 // bdlat_arrayfunctions.cpp                                           -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
 #include <bdlat_arrayfunctions.h>
 
 #include <bsls_ident.h>

diff --git a/groups/bdl/bdlat/bdlat_arrayfunctions.h b/groups/bdl/bdlat/bdlat_arrayfunctions.h
@@ -1,12 +1,4 @@
 // bdlat_arrayfunctions.h                                             -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
 #ifndef INCLUDED_BDLAT_ARRAYFUNCTIONS
 #define INCLUDED_BDLAT_ARRAYFUNCTIONS
 
@@ -85,7 +77,7 @@ BSLS_IDENT("$Id: $")
 //
 ///Usage
 ///-----
-// The following code illustrate the usage of this component.
+// This section illustrates intended use of this component.
 //
 ///Example 1: Defining an "Array" Type
 ///- - - - - - - - - - - - - - - - - -

diff --git a/groups/bdl/bdlat/bdlat_arrayfunctions.t.cpp b/groups/bdl/bdlat/bdlat_arrayfunctions.t.cpp
@@ -1,12 +1,5 @@
 // bdlat_arrayfunctions.t.cpp                                         -*-C++-*-
 
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
 #include <bsls_platform.h>
 
 // the following suppresses warnings from '#include' inlined functions

diff --git a/groups/bdl/bdlat/bdlat_arrayiterators.cpp b/groups/bdl/bdlat/bdlat_arrayiterators.cpp
@@ -1,13 +1,4 @@
 // bdlat_arrayiterators.cpp                                           -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
-
 #include <bdlat_arrayiterators.h>
 
 namespace BloombergLP {

diff --git a/groups/bdl/bdlat/bdlat_arrayiterators.h b/groups/bdl/bdlat/bdlat_arrayiterators.h
@@ -1,12 +1,4 @@
 // bdlat_arrayiterators.h                                             -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
 #ifndef INCLUDED_BDLAT_ARRAYITERATORS
 #define INCLUDED_BDLAT_ARRAYITERATORS
 
@@ -59,6 +51,10 @@ BSLS_IDENT("$Id: $")
 //
 ///Usage
 ///-----
+// This section illustrates intended use of this component.
+//
+///Example 1: Basic Usage
+/// - - - - - - - - - - -
 // To use the facilities in this component, you must of course include the
 // header file:
 //..

diff --git a/groups/bdl/bdlat/bdlat_arrayiterators.t.cpp b/groups/bdl/bdlat/bdlat_arrayiterators.t.cpp
@@ -1,13 +1,4 @@
 // bdlat_arrayiterators.t.cpp                                         -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
-
 #include <bdlat_arrayiterators.h>
 
 #include <bdlat_arrayfunctions.h>

diff --git a/groups/bdl/bdlat/bdlat_attributeinfo.cpp b/groups/bdl/bdlat/bdlat_attributeinfo.cpp
@@ -1,12 +1,4 @@
 // bdlat_attributeinfo.cpp                                            -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
 #include <bdlat_attributeinfo.h>
 
 #include <bsls_ident.h>

diff --git a/groups/bdl/bdlat/bdlat_attributeinfo.h b/groups/bdl/bdlat/bdlat_attributeinfo.h
@@ -1,12 +1,4 @@
 // bdlat_attributeinfo.h                                              -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
 #ifndef INCLUDED_BDLAT_ATTRIBUTEINFO
 #define INCLUDED_BDLAT_ATTRIBUTEINFO
 
@@ -36,7 +28,10 @@ BSLS_IDENT("$Id: $")
 //
 ///Usage
 ///-----
-// The following snippets of code illustrate the usage of this component.
+// This section illustrates intended use of this component.
+//
+///Example 1: Basic Usage
+/// - - - - - - - - - - -
 // Suppose you create an accessor for sequence attributes that prints each
 // attribute to an output stream:
 //..

diff --git a/groups/bdl/bdlat/bdlat_attributeinfo.t.cpp b/groups/bdl/bdlat/bdlat_attributeinfo.t.cpp
@@ -1,13 +1,4 @@
 // bdlat_attributeinfo.t.cpp                                          -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
-
 #include <bdlat_attributeinfo.h>
 
 #include <bslim_testutil.h>
@@ -27,7 +18,7 @@ using namespace bsl;  // automatically added by script
 //-----------------------------------------------------------------------------
 //                              Overview
 //                              --------
-//                                  TBD doc
+// TBD doc
 //-----------------------------------------------------------------------------
 // [ 2]
 //-----------------------------------------------------------------------------

diff --git a/groups/bdl/bdlat/bdlat_choicefunctions.cpp b/groups/bdl/bdlat/bdlat_choicefunctions.cpp
@@ -1,12 +1,4 @@
 // bdlat_choicefunctions.cpp                                          -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
 #include <bdlat_choicefunctions.h>
 
 #include <bsls_ident.h>

diff --git a/groups/bdl/bdlat/bdlat_choicefunctions.h b/groups/bdl/bdlat/bdlat_choicefunctions.h
@@ -1,12 +1,4 @@
 // bdlat_choicefunctions.h                                            -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
 #ifndef INCLUDED_BDLAT_CHOICEFUNCTIONS
 #define INCLUDED_BDLAT_CHOICEFUNCTIONS
 
@@ -95,6 +87,10 @@ BSLS_IDENT("$Id: $")
 //
 ///Usage
 ///-----
+// This section illustrates intended use of this component.
+//
+///Example 1: Basic Usage
+/// - - - - - - - - - - -
 // Suppose you had a 'union' embedded inside a 'struct'.  The 'struct' also
 // contains a 'd_selectionId' member that specifies which member of the 'union'
 // is selected.  The default constructor of the 'struct' makes the selection

diff --git a/groups/bdl/bdlat/bdlat_choicefunctions.t.cpp b/groups/bdl/bdlat/bdlat_choicefunctions.t.cpp
@@ -1,12 +1,4 @@
 // bdlat_choicefunctions.t.cpp                                        -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
 #include <bdlat_choicefunctions.h>
 
 #include <bslim_testutil.h>

diff --git a/groups/bdl/bdlat/bdlat_customizedtypefunctions.cpp b/groups/bdl/bdlat/bdlat_customizedtypefunctions.cpp
@@ -1,12 +1,4 @@
 // bdlat_customizedtypefunctions.cpp                                  -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
 #include <bdlat_customizedtypefunctions.h>
 
 #include <bsls_ident.h>

diff --git a/groups/bdl/bdlat/bdlat_customizedtypefunctions.h b/groups/bdl/bdlat/bdlat_customizedtypefunctions.h
@@ -1,12 +1,4 @@
 // bdlat_customizedtypefunctions.h                                    -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
 #ifndef INCLUDED_BDLAT_CUSTOMIZEDTYPEFUNCTIONS
 #define INCLUDED_BDLAT_CUSTOMIZEDTYPEFUNCTIONS
 
@@ -67,7 +59,10 @@ BSLS_IDENT("$Id: $")
 //
 ///Usage
 ///-----
-// The following snippets of code illustrate the usage of this component.
+// This section illustrates intended use of this component.
+//
+///Example 1: Basic Usage
+/// - - - - - - - - - - -
 // Suppose we have a customized type called 'Cusip', holding an object of type
 // 'bsl::string' with a restriction that the length of the string cannot be
 // longer than nine characters.  We can obtain the value of the string using

diff --git a/groups/bdl/bdlat/bdlat_customizedtypefunctions.t.cpp b/groups/bdl/bdlat/bdlat_customizedtypefunctions.t.cpp
@@ -1,22 +1,14 @@
 // bdlat_customizedtypefunctions.t.cpp                                -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
-
 #include <bdlat_customizedtypefunctions.h>
 
-#include <bslim_testutil.h>
-
 #include <bdlat_typetraits.h>
+
+#include <bdlb_printmethods.h>
 #include <bslalg_typetraits.h>
+#include <bslim_testutil.h>
 #include <bslma_allocator.h>
-
 #include <bslmf_integralconstant.h>   // for testing only
+#include <bsls_assert.h>
 
 #include <bsl_cstdlib.h>
 #include <bsl_cstring.h>
@@ -26,11 +18,6 @@
 #include <bsl_string.h>
 #include <bsl_vector.h>
 
-#include <bsls_assert.h>
-
-#include <bdlb_printmethods.h>
-
-
 using namespace BloombergLP;
 using namespace bsl;
 

diff --git a/groups/bdl/bdlat/bdlat_enumeratorinfo.cpp b/groups/bdl/bdlat/bdlat_enumeratorinfo.cpp
@@ -1,12 +1,4 @@
 // bdlat_enumeratorinfo.cpp                                           -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
 #include <bdlat_enumeratorinfo.h>
 
 #include <bsls_ident.h>

diff --git a/groups/bdl/bdlat/bdlat_enumeratorinfo.h b/groups/bdl/bdlat/bdlat_enumeratorinfo.h
@@ -1,12 +1,4 @@
 // bdlat_enumeratorinfo.h                                             -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
 #ifndef INCLUDED_BDLAT_ENUMERATORINFO
 #define INCLUDED_BDLAT_ENUMERATORINFO
 
@@ -29,6 +21,10 @@ BSLS_IDENT("$Id: $")
 //
 ///Usage
 ///-----
+// This section illustrates intended use of this component.
+//
+///Example 1: Basic Usage
+/// - - - - - - - - - - -
 // TBD doc
 
 #include <bdlscm_version.h>

diff --git a/groups/bdl/bdlat/bdlat_enumeratorinfo.t.cpp b/groups/bdl/bdlat/bdlat_enumeratorinfo.t.cpp
@@ -1,33 +1,22 @@
 // bdlat_enumeratorinfo.t.cpp                                         -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
-
 #include <bdlat_enumeratorinfo.h>
 
 #include <bslim_testutil.h>
-
 #include <bsls_compilerfeatures.h>
 
 #include <bsl_cstdlib.h>
 #include <bsl_cstring.h>
 #include <bsl_iostream.h>
 
 using namespace BloombergLP;
-using namespace bsl;  // automatically added by script
-
+using namespace bsl;
 
 //=============================================================================
 //                             TEST PLAN
 //-----------------------------------------------------------------------------
 //                              Overview
 //                              --------
-//                                  TBD doc
+// TBD doc
 //-----------------------------------------------------------------------------
 // [ 2]
 //-----------------------------------------------------------------------------

diff --git a/groups/bdl/bdlat/bdlat_enumfunctions.cpp b/groups/bdl/bdlat/bdlat_enumfunctions.cpp
@@ -1,12 +1,4 @@
 // bdlat_enumfunctions.cpp                                            -*-C++-*-
-
-// ----------------------------------------------------------------------------
-//                                   NOTICE
-//
-// This component is not up to date with current BDE coding standards, and
-// should not be used as an example for new development.
-// ----------------------------------------------------------------------------
-
 #include <bdlat_enumfunctions.h>
 
 #include <bsls_ident.h>