diff --git a/include/acestl/reactor/custom_event_handler.hpp b/include/acestl/reactor/custom_event_handler.hpp index 1777f645..5221d793 100644 --- a/include/acestl/reactor/custom_event_handler.hpp +++ b/include/acestl/reactor/custom_event_handler.hpp @@ -4,11 +4,11 @@ * Purpose: Event handler class for custom event notifications. * * Created: 1st October 2004 - * Updated: 21st March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2004-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -55,7 +55,7 @@ # define ACESTL_VER_ACESTL_REACTOR_HPP_CUSTOM_EVENT_HANDLER_MAJOR 2 # define ACESTL_VER_ACESTL_REACTOR_HPP_CUSTOM_EVENT_HANDLER_MINOR 1 # define ACESTL_VER_ACESTL_REACTOR_HPP_CUSTOM_EVENT_HANDLER_REVISION 13 -# define ACESTL_VER_ACESTL_REACTOR_HPP_CUSTOM_EVENT_HANDLER_EDIT 47 +# define ACESTL_VER_ACESTL_REACTOR_HPP_CUSTOM_EVENT_HANDLER_EDIT 48 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -347,7 +347,7 @@ class custom_event_handler * * \return \c nullptr on failure, the event id on success * - * \remarks The custom event can be cancelled via cancel_custom_event() + * \note The custom event can be cancelled via cancel_custom_event(). * * \note Custom events are "one-shot". When the event delay elapses and the * handle_custom_event() callback is called, the event has been deregistered from @@ -365,7 +365,7 @@ class custom_event_handler * * \return \c nullptr on failure, the event id on success * - * \remarks The custom event can be cancelled via cancel_custom_event() + * \note The custom event can be cancelled via cancel_custom_event(). * * \note Custom events are "one-shot". When the event delay elapses and the * handle_custom_event() callback is called, the event has been deregistered from diff --git a/include/atlstl/automation/multiple_dispatch.hpp b/include/atlstl/automation/multiple_dispatch.hpp index e9a3229d..836a9869 100644 --- a/include/atlstl/automation/multiple_dispatch.hpp +++ b/include/atlstl/automation/multiple_dispatch.hpp @@ -5,11 +5,11 @@ * through multiple IDispatch interfaces visible to script clients. * * Created: 15th May 2006 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2007-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -57,7 +57,7 @@ # define ATLSTL_VER_ATLSTL_AUTOMATION_HPP_MULTIPLE_DISPATCH_MAJOR 2 # define ATLSTL_VER_ATLSTL_AUTOMATION_HPP_MULTIPLE_DISPATCH_MINOR 1 # define ATLSTL_VER_ATLSTL_AUTOMATION_HPP_MULTIPLE_DISPATCH_REVISION 5 -# define ATLSTL_VER_ATLSTL_AUTOMATION_HPP_MULTIPLE_DISPATCH_EDIT 30 +# define ATLSTL_VER_ATLSTL_AUTOMATION_HPP_MULTIPLE_DISPATCH_EDIT 31 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -214,7 +214,7 @@ class IDispatchImpl2 * which has thus undertaken to interpret them. This stripe is then * detected * - * \remarks Names are matched en bloc: they are either all matched by one + * \note Names are matched en bloc: they are either all matched by one * interface, or all by the other. It is never the case that * some part are matched by one and the remainder by the other. * @@ -274,7 +274,7 @@ class IDispatchImpl2 * from which the appropriate dispiniterface is determined. The * stripe is then removed, and the method invoked. * - * \remarks Names are matched en bloc: they are either all matched by one + * \note Names are matched en bloc: they are either all matched by one * interface, or all by the other. It is never the case that * some part are matched by one and the remainder by the other. * @@ -365,7 +365,7 @@ class IDispatchImpl3 * which has thus undertaken to interpret them. This stripe is then * detected * - * \remarks Names are matched en bloc: they are either all matched by one + * \note Names are matched en bloc: they are either all matched by one * interface, or all by the other. It is never the case that * some part are matched by one and the remainder by the other. * @@ -433,7 +433,7 @@ class IDispatchImpl3 * from which the appropriate dispiniterface is determined. The * stripe is then removed, and the method invoked. * - * \remarks Names are matched en bloc: they are either all matched by one + * \note Names are matched en bloc: they are either all matched by one * interface, or all by the other. It is never the case that * some part are matched by one and the remainder by the other. * @@ -540,7 +540,7 @@ class IDispatchImpl4 * which has thus undertaken to interpret them. This stripe is then * detected * - * \remarks Names are matched en bloc: they are either all matched by one + * \note Names are matched en bloc: they are either all matched by one * interface, or all by the other. It is never the case that * some part are matched by one and the remainder by the other. * @@ -616,7 +616,7 @@ class IDispatchImpl4 * from which the appropriate dispiniterface is determined. The * stripe is then removed, and the method invoked. * - * \remarks Names are matched en bloc: they are either all matched by one + * \note Names are matched en bloc: they are either all matched by one * interface, or all by the other. It is never the case that * some part are matched by one and the remainder by the other. * diff --git a/include/comstl/collections/collection_sequence.hpp b/include/comstl/collections/collection_sequence.hpp index 93b6dfeb..973b38fd 100644 --- a/include/comstl/collections/collection_sequence.hpp +++ b/include/comstl/collections/collection_sequence.hpp @@ -4,7 +4,7 @@ * Purpose: STL sequence for COM collection interfaces. * * Created: 17th September 1998 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Thanks: To Eduardo Bezerra and Vivi Orunitia for reporting * incompatibilities with Borland's 5.82 (Turbo C++). The awful @@ -12,7 +12,7 @@ * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 1998-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -59,7 +59,7 @@ # define COMSTL_VER_COMSTL_COLLECTIONS_HPP_COLLECTION_SEQUENCE_MAJOR 6 # define COMSTL_VER_COMSTL_COLLECTIONS_HPP_COLLECTION_SEQUENCE_MINOR 1 # define COMSTL_VER_COMSTL_COLLECTIONS_HPP_COLLECTION_SEQUENCE_REVISION 19 -# define COMSTL_VER_COMSTL_COLLECTIONS_HPP_COLLECTION_SEQUENCE_EDIT 126 +# define COMSTL_VER_COMSTL_COLLECTIONS_HPP_COLLECTION_SEQUENCE_EDIT 127 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -185,7 +185,7 @@ typedef collection_sequence< * \note The iterator instances returned by begin() and end() are valid outside * the lifetime of the collection instance from which they are obtained * - * \remarks A detailed examination of the design and implementation of this + * \note A detailed examination of the design and implementation of this * class template is described in Chapters 28 and 29 of * Extended STL, volume 1 * (published by Addison-Wesley, June 2007). diff --git a/include/comstl/collections/enumeration_policies.hpp b/include/comstl/collections/enumeration_policies.hpp index b123d09d..6c1ad92d 100644 --- a/include/comstl/collections/enumeration_policies.hpp +++ b/include/comstl/collections/enumeration_policies.hpp @@ -4,11 +4,11 @@ * Purpose: Policies for enumerator interface handling. * * Created: 20th December 2003 - * Updated: 21st March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2003-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -54,7 +54,7 @@ # define COMSTL_VER_COMSTL_COLLECTIONS_HPP_ENUMERATION_POLICIES_MAJOR 6 # define COMSTL_VER_COMSTL_COLLECTIONS_HPP_ENUMERATION_POLICIES_MINOR 1 # define COMSTL_VER_COMSTL_COLLECTIONS_HPP_ENUMERATION_POLICIES_REVISION 16 -# define COMSTL_VER_COMSTL_COLLECTIONS_HPP_ENUMERATION_POLICIES_EDIT 76 +# define COMSTL_VER_COMSTL_COLLECTIONS_HPP_ENUMERATION_POLICIES_EDIT 77 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -205,7 +205,7 @@ struct input_cloning_policy public: /// Gets a working "copy" of the given enumerator root /// - /// \remarks For this policy, this simply calls AddRef() + /// \note For this policy, this simply calls AddRef(). static interface_type *get_working_instance(interface_type *root) { COMSTL_ASSERT(NULL != root); @@ -254,7 +254,7 @@ struct cloneable_cloning_policy public: /// Gets a working "copy" of the given enumerator root /// - /// \remarks For this policy, this calls Clone(), and returns \c nullptr + /// \note For this policy, this calls Clone(), and returns \c nullptr /// if that fails. static interface_type *get_working_instance(interface_type *root) { @@ -324,7 +324,7 @@ struct forward_cloning_policy public: /// Gets a working "copy" of the given enumerator root /// - /// \remarks For this policy, this calls Clone(), and throws an + /// \note For this policy, this calls Clone(), and throws an /// instance of comstl::clone_failure if that fails (or returns /// \c nullptr if exception support is disabled). static interface_type *get_working_instance(interface_type *root) @@ -443,7 +443,7 @@ struct policy_adaptor * * \ingroup group__library__Collection * - * \remarks Invokes the the get__NewEnum() method + * \note Invokes the the get__NewEnum() method. */ template struct new_enum_property_policy @@ -475,7 +475,7 @@ struct new_enum_property_policy * * \ingroup group__library__Collection * - * \remarks Invokes the the _NewEnum() method + * \note Invokes the the _NewEnum() method. */ template struct new_enum_method_policy @@ -497,7 +497,7 @@ struct new_enum_method_policy * * \ingroup group__library__Collection * - * \remarks Calls IDispatch::Invoke(DISPID_NEWENUM, . . . , DISPATCH_METHOD | DISPATCH_PROPERTYGET, . . . ); + * \note Calls IDispatch::Invoke(DISPID_NEWENUM, . . . , DISPATCH_METHOD | DISPATCH_PROPERTYGET, . . . ); */ template struct new_enum_by_dispid_policy diff --git a/include/comstl/collections/enumerator_sequence.hpp b/include/comstl/collections/enumerator_sequence.hpp index fa223b91..956efee0 100644 --- a/include/comstl/collections/enumerator_sequence.hpp +++ b/include/comstl/collections/enumerator_sequence.hpp @@ -4,7 +4,7 @@ * Purpose: STL sequence for IEnumXXXX enumerator interfaces. * * Created: 17th September 1998 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Thanks: To Eduardo Bezerra and Vivi Orunitia for reporting * incompatibilities with Borland's 5.82 (Turbo C++). The awful @@ -12,7 +12,7 @@ * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 1998-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -59,7 +59,7 @@ # define COMSTL_VER_COMSTL_COLLECTIONS_HPP_ENUMERATOR_SEQUENCE_MAJOR 6 # define COMSTL_VER_COMSTL_COLLECTIONS_HPP_ENUMERATOR_SEQUENCE_MINOR 1 # define COMSTL_VER_COMSTL_COLLECTIONS_HPP_ENUMERATOR_SEQUENCE_REVISION 15 -# define COMSTL_VER_COMSTL_COLLECTIONS_HPP_ENUMERATOR_SEQUENCE_EDIT 280 +# define COMSTL_VER_COMSTL_COLLECTIONS_HPP_ENUMERATOR_SEQUENCE_EDIT 281 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -186,7 +186,7 @@ std::for_each(guids.begin(), guids.end(), dump_GUID); * \note The iterator instances returned by begin() and end() are valid outside * the lifetime of the collection instance from which they are obtained * - * \remarks A detailed examination of the design and implementation of this + * \note A detailed examination of the design and implementation of this * class template is described in Chapters 28 and 29 of * Extended STL, volume 1 * (published by Addison-Wesley, June 2007). diff --git a/include/comstl/exception/variant_type_exception.hpp b/include/comstl/exception/variant_type_exception.hpp index b306ea41..3d5391b9 100644 --- a/include/comstl/exception/variant_type_exception.hpp +++ b/include/comstl/exception/variant_type_exception.hpp @@ -4,11 +4,11 @@ * Purpose: COM-related exception classes, and their policy classes * * Created: 8th December 2004 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2004-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -55,7 +55,7 @@ # define COMSTL_VER_COMSTL_EXCEPTION_HPP_VARIANT_TYPE_EXCEPTION_MAJOR 3 # define COMSTL_VER_COMSTL_EXCEPTION_HPP_VARIANT_TYPE_EXCEPTION_MINOR 0 # define COMSTL_VER_COMSTL_EXCEPTION_HPP_VARIANT_TYPE_EXCEPTION_REVISION 5 -# define COMSTL_VER_COMSTL_EXCEPTION_HPP_VARIANT_TYPE_EXCEPTION_EDIT 61 +# define COMSTL_VER_COMSTL_EXCEPTION_HPP_VARIANT_TYPE_EXCEPTION_EDIT 62 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -103,7 +103,7 @@ namespace comstl_project * * \ingroup group__library__Exception * - * \remarks This is thrown by comstl::safearray_sequence on variant type + * \note This is thrown by comstl::safearray_sequence on variant type * mismatches. */ class variant_type_exception diff --git a/include/comstl/util/object_functions.h b/include/comstl/util/object_functions.h index b05e2c49..91cf0d56 100644 --- a/include/comstl/util/object_functions.h +++ b/include/comstl/util/object_functions.h @@ -4,11 +4,11 @@ * Purpose: Reference-counting helper functions. * * Created: 2nd March 1996 - * Updated: 24th December 2024 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 1996-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -54,7 +54,7 @@ # define COMSTL_VER_COMSTL_UTIL_H_OBJECT_FUNCTIONS_MAJOR 3 # define COMSTL_VER_COMSTL_UTIL_H_OBJECT_FUNCTIONS_MINOR 2 # define COMSTL_VER_COMSTL_UTIL_H_OBJECT_FUNCTIONS_REVISION 1 -# define COMSTL_VER_COMSTL_UTIL_H_OBJECT_FUNCTIONS_EDIT 81 +# define COMSTL_VER_COMSTL_UTIL_H_OBJECT_FUNCTIONS_EDIT 82 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -108,7 +108,7 @@ namespace comstl_project * * \pre \c p is a \c nullptr pointer, or a valid pointer to a COM interface. * - * \remarks If the function success, the caller must release the reference + * \note If the function success, the caller must release the reference * count associated with the interface pointer in \c *identity. * * \note Intended for use in C-compilation units only. For C++, use @@ -306,7 +306,7 @@ namespace comstl * * \pre \c p is a \c nullptr pointer, or a valid pointer to a COM interface. * - * \remarks If the function success, the caller must release the reference + * \note If the function success, the caller must release the reference * count associated with the interface pointer in \c *identity. * * \note Implemented in terms of the C-compatible function diff --git a/include/comstl/util/variant.hpp b/include/comstl/util/variant.hpp index 58b576da..a71facf6 100644 --- a/include/comstl/util/variant.hpp +++ b/include/comstl/util/variant.hpp @@ -4,11 +4,11 @@ * Purpose: variant class. * * Created: 12th December 1996 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 1996-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -54,7 +54,7 @@ # define _COMSTL_VER_COMSTL_UTIL_HPP_COMSTL_VARIANT_MAJOR 2 # define _COMSTL_VER_COMSTL_UTIL_HPP_COMSTL_VARIANT_MINOR 3 # define _COMSTL_VER_COMSTL_UTIL_HPP_COMSTL_VARIANT_REVISION 15 -# define _COMSTL_VER_COMSTL_UTIL_HPP_COMSTL_VARIANT_EDIT 180 +# define _COMSTL_VER_COMSTL_UTIL_HPP_COMSTL_VARIANT_EDIT 181 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -127,7 +127,7 @@ namespace comstl_project * * \ingroup group__library__COM_Utility * - * \remarks comstl::variant publicly derives from \c VARIANT as a measure of + * \note comstl::variant publicly derives from \c VARIANT as a measure of * expedience, rather than as an act of design sophistication. Any manual * manipulation of the instances, or their member variables, is at the * user's risk. Notwithstanding, this is helped by the fact that diff --git a/include/inetstl/util/uds_helpers.h b/include/inetstl/util/uds_helpers.h index e12a5b1f..beeacd87 100644 --- a/include/inetstl/util/uds_helpers.h +++ b/include/inetstl/util/uds_helpers.h @@ -4,7 +4,7 @@ * Purpose: Unix Domain Sockets helper functions * * Created: 21st February 2025 - * Updated: 29th May 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * @@ -53,7 +53,7 @@ # define INETSTL_VER_INETSTL_UTIL_H_UDS_HELPERS_MAJOR 1 # define INETSTL_VER_INETSTL_UTIL_H_UDS_HELPERS_MINOR 0 # define INETSTL_VER_INETSTL_UTIL_H_UDS_HELPERS_REVISION 2 -# define INETSTL_VER_INETSTL_UTIL_H_UDS_HELPERS_EDIT 4 +# define INETSTL_VER_INETSTL_UTIL_H_UDS_HELPERS_EDIT 5 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -159,7 +159,7 @@ inetstl_c_sockaddr_un_init_from_path( * - on macOS, `sockaddr_un` has field `sun_len`, which is not * present on Linux; * - the field `sun_path` has a fixed size (of 104, or 108, or ...), - * and there are some differences in whether a NUL-terminator is + * and there are some differences in whether a NUL character is * required, hence if the path length is exactly the same as the * available fixed space then there is an issue; * diff --git a/include/mfcstl/shims/attribute/get_kernel_handle.hpp b/include/mfcstl/shims/attribute/get_kernel_handle.hpp index f030aada..5a924bb2 100644 --- a/include/mfcstl/shims/attribute/get_kernel_handle.hpp +++ b/include/mfcstl/shims/attribute/get_kernel_handle.hpp @@ -4,11 +4,11 @@ * Purpose: Contains classes and functions for dealing with Win32 handles. * * Created: 24th December 2006 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2006-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -55,7 +55,7 @@ # define MFCSTL_VER_MFCSTL_SHIMS_ATTRIBUTE_HPP_GET_KERNEL_HANDLE_MAJOR 1 # define MFCSTL_VER_MFCSTL_SHIMS_ATTRIBUTE_HPP_GET_KERNEL_HANDLE_MINOR 1 # define MFCSTL_VER_MFCSTL_SHIMS_ATTRIBUTE_HPP_GET_KERNEL_HANDLE_REVISION 7 -# define MFCSTL_VER_MFCSTL_SHIMS_ATTRIBUTE_HPP_GET_KERNEL_HANDLE_EDIT 25 +# define MFCSTL_VER_MFCSTL_SHIMS_ATTRIBUTE_HPP_GET_KERNEL_HANDLE_EDIT 26 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -112,11 +112,6 @@ namespace winstl_project * \param ev The event instance * * \retval The handle \c h - * - * \remarks We cannot simply define the shim overload in terms of - * CEvent for two reasons. First, the template - * mechanism requires a precise shim when the - * */ inline HANDLE get_kernel_handle(CEvent &ev) { @@ -131,11 +126,6 @@ inline HANDLE get_kernel_handle(CEvent &ev) * \param mx The mutex instance * * \retval The handle \c h - * - * \remarks We cannot simply define the shim overload in terms of - * CMutex for two reasons. First, the template - * mechanism requires a precise shim when the - * */ inline HANDLE get_kernel_handle(CMutex &mx) { @@ -150,11 +140,6 @@ inline HANDLE get_kernel_handle(CMutex &mx) * \param sem The semaphore instance * * \retval The handle \c h - * - * \remarks We cannot simply define the shim overload in terms of - * CSemaphore for two reasons. First, the template - * mechanism requires a precise shim when the - * */ inline HANDLE get_kernel_handle(CSemaphore &sem) { diff --git a/include/mfcstl/shims/attribute/get_synch_handle.hpp b/include/mfcstl/shims/attribute/get_synch_handle.hpp index 174b0822..1f7bfe1a 100644 --- a/include/mfcstl/shims/attribute/get_synch_handle.hpp +++ b/include/mfcstl/shims/attribute/get_synch_handle.hpp @@ -4,11 +4,11 @@ * Purpose: Contains classes and functions for dealing with Win32 handles. * * Created: 24th December 2006 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2006-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -55,7 +55,7 @@ # define MFCSTL_VER_MFCSTL_SHIMS_ATTRIBUTE_HPP_GET_SYNCH_HANDLE_MAJOR 1 # define MFCSTL_VER_MFCSTL_SHIMS_ATTRIBUTE_HPP_GET_SYNCH_HANDLE_MINOR 2 # define MFCSTL_VER_MFCSTL_SHIMS_ATTRIBUTE_HPP_GET_SYNCH_HANDLE_REVISION 4 -# define MFCSTL_VER_MFCSTL_SHIMS_ATTRIBUTE_HPP_GET_SYNCH_HANDLE_EDIT 22 +# define MFCSTL_VER_MFCSTL_SHIMS_ATTRIBUTE_HPP_GET_SYNCH_HANDLE_EDIT 23 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -120,7 +120,7 @@ namespace winstl_project * * \retval The synchronisation handle associated with the event * - * \remarks We cannot simply define the shim overload in terms of + * \note We cannot simply define the shim overload in terms of * CSyncObject for two reasons. First, the template * mechanism requires a precise type for the shim, not an * inheritance-related group of types. Second, the class @@ -147,7 +147,7 @@ get_synch_handle( * * \retval The synchronisation handle associated with the mutex * - * \remarks We cannot simply define the shim overload in terms of + * \note We cannot simply define the shim overload in terms of * CSyncObject for two reasons. First, the template * mechanism requires a precise type for the shim, not an * inheritance-related group of types. Second, the class @@ -174,7 +174,7 @@ get_synch_handle( * * \retval The synchronisation handle associated with the semaphore * - * \remarks We cannot simply define the shim overload in terms of + * \note We cannot simply define the shim overload in terms of * CSyncObject for two reasons. First, the template * mechanism requires a precise type for the shim, not an * inheritance-related group of types. Second, the class diff --git a/include/platformstl/filesystem/cwd_stack.hpp b/include/platformstl/filesystem/cwd_stack.hpp index bfd4c249..e51c8fd3 100644 --- a/include/platformstl/filesystem/cwd_stack.hpp +++ b/include/platformstl/filesystem/cwd_stack.hpp @@ -4,11 +4,11 @@ * Purpose: Platform header for the filesystem_traits components. * * Created: 16th July 2006 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2006-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -56,7 +56,7 @@ # define PLATFORMSTL_VER_PLATFORMSTL_FILESYSTEM_HPP_CWD_STACK_MAJOR 2 # define PLATFORMSTL_VER_PLATFORMSTL_FILESYSTEM_HPP_CWD_STACK_MINOR 2 # define PLATFORMSTL_VER_PLATFORMSTL_FILESYSTEM_HPP_CWD_STACK_REVISION 1 -# define PLATFORMSTL_VER_PLATFORMSTL_FILESYSTEM_HPP_CWD_STACK_EDIT 42 +# define PLATFORMSTL_VER_PLATFORMSTL_FILESYSTEM_HPP_CWD_STACK_EDIT 43 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -147,7 +147,8 @@ class basic_cwd_stack /// /// - /// \remarks If fails, then platformstl::system_traits::get_last_error() gives the error + /// \note If fails, then platformstl::system_traits::get_last_error() + /// gives the error. bool_type try_pop(); public: diff --git a/include/platformstl/platformstl.h b/include/platformstl/platformstl.h index d2862a2d..dba480cb 100644 --- a/include/platformstl/platformstl.h +++ b/include/platformstl/platformstl.h @@ -5,7 +5,7 @@ * platform discriminations, and definitions of types. * * Created: 20th March 2005 - * Updated: 10th October 2026 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * @@ -50,7 +50,7 @@ # define PLATFORMSTL_VER_PLATFORMSTL_H_PLATFORMSTL_MAJOR 1 # define PLATFORMSTL_VER_PLATFORMSTL_H_PLATFORMSTL_MINOR 15 # define PLATFORMSTL_VER_PLATFORMSTL_H_PLATFORMSTL_REVISION 9 -# define PLATFORMSTL_VER_PLATFORMSTL_H_PLATFORMSTL_EDIT 64 +# define PLATFORMSTL_VER_PLATFORMSTL_H_PLATFORMSTL_EDIT 65 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ /** \file platformstl/platformstl.h @@ -331,7 +331,7 @@ * * \param expr Must be non-zero, or an assertion will be fired * - * \remarks By default this is defined to \ref STLSOFT_ASSERT. However, this + * \note By default this is defined to \ref STLSOFT_ASSERT. However, this * can be overriden if a prior definition is encountered, allowing the * runtime assertion of WinSTL components to use a different mechanism to * those in the other \ref group__projects "projects". @@ -353,7 +353,7 @@ * * \param expr A compile-time evaluatable condition that must be non-zero, or compilation will fail. * - * \remarks This is defined to \ref STLSOFT_STATIC_ASSERT. + * \note This is defined to \ref STLSOFT_STATIC_ASSERT. */ #define PLATFORMSTL_STATIC_ASSERT(expr) STLSOFT_STATIC_ASSERT(expr) diff --git a/include/stlsoft/containers/frequency_map.hpp b/include/stlsoft/containers/frequency_map.hpp index 5828d1a2..a5c390dc 100644 --- a/include/stlsoft/containers/frequency_map.hpp +++ b/include/stlsoft/containers/frequency_map.hpp @@ -5,11 +5,11 @@ * it contains. * * Created: 1st October 2005 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2005-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -56,7 +56,7 @@ # define STLSOFT_VER_STLSOFT_CONTAINERS_HPP_FREQUENCY_MAP_MAJOR 2 # define STLSOFT_VER_STLSOFT_CONTAINERS_HPP_FREQUENCY_MAP_MINOR 10 # define STLSOFT_VER_STLSOFT_CONTAINERS_HPP_FREQUENCY_MAP_REVISION 1 -# define STLSOFT_VER_STLSOFT_CONTAINERS_HPP_FREQUENCY_MAP_EDIT 57 +# define STLSOFT_VER_STLSOFT_CONTAINERS_HPP_FREQUENCY_MAP_EDIT 58 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -549,8 +549,8 @@ class frequency_map /// The number of unique entries in the map /// - /// \remarks This may not be the same as the number of calls to - /// push() + /// \note This may not be the same as the number of calls to + /// push(). size_type size() const STLSOFT_NOEXCEPT { STLSOFT_ASSERT(is_valid()); @@ -560,8 +560,8 @@ class frequency_map /// The number of non-unique entries in the map /// - /// \remarks This may not be the same as the number of calls to - /// push() + /// \note This may not be the same as the number of calls to + /// push(). count_type total() const STLSOFT_NOEXCEPT { STLSOFT_ASSERT(is_valid()); diff --git a/include/stlsoft/conversion/integer_to_string/integer_to_base32_string.hpp b/include/stlsoft/conversion/integer_to_string/integer_to_base32_string.hpp index 93202a46..89e2ba91 100644 --- a/include/stlsoft/conversion/integer_to_string/integer_to_base32_string.hpp +++ b/include/stlsoft/conversion/integer_to_string/integer_to_base32_string.hpp @@ -5,7 +5,7 @@ * representation. * * Created: 17th February 2024 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * @@ -55,7 +55,7 @@ # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_BASE32_STRING_MAJOR 1 # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_BASE32_STRING_MINOR 0 # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_BASE32_STRING_REVISION 2 -# define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_BASE32_STRING_EDIT 3 +# define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_BASE32_STRING_EDIT 4 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -237,8 +237,7 @@ unsigned_integer_to_base32_string_3_( T_character* end = buf + (cchBuf - 1); - // Whichever we do it, we write the nul-terminator (and move down - // one) + // Whichever we do it, we write the NUL character (and move down one) *end-- = '\0'; STLSOFT_COVER_MARK_LINE(); @@ -635,7 +634,7 @@ STLSOFT_CLOSE_WORKER_NS_(ximpl_I2S) /** Converts an integer value into a base-32 string representation in the * given character buffer, assigning the number of characters (excluding - * the nul-terminator) written into the given size variable. + * the NUL character) written into the given size variable. * * \tparam T_integer Type of the integer to be converted * \tparam T_character Type of the character array into which the conversion @@ -645,7 +644,7 @@ STLSOFT_CLOSE_WORKER_NS_(ximpl_I2S) * \param cchBuf Number of character available in \c buf * \param i The value to be converted to octal string * \param numWritten Pointer to a variable to receive the number of - * characters written (excluding nul-terminator) + * characters written (excluding NUL character); * * \pre nullptr != buf * \pre cchBuf > integral_format_width_limits::maxDuotrigesimalWidth diff --git a/include/stlsoft/conversion/integer_to_string/integer_to_base36_string.hpp b/include/stlsoft/conversion/integer_to_string/integer_to_base36_string.hpp index 71dabd47..5714a856 100644 --- a/include/stlsoft/conversion/integer_to_string/integer_to_base36_string.hpp +++ b/include/stlsoft/conversion/integer_to_string/integer_to_base36_string.hpp @@ -5,7 +5,7 @@ * representation. * * Created: 14th February 2024 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * @@ -55,7 +55,7 @@ # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_BASE36_STRING_MAJOR 1 # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_BASE36_STRING_MINOR 0 # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_BASE36_STRING_REVISION 2 -# define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_BASE36_STRING_EDIT 3 +# define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_BASE36_STRING_EDIT 4 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -245,8 +245,7 @@ unsigned_integer_to_base36_string_3_( T_character* end = buf + (cchBuf - 1); - // Whichever we do it, we write the nul-terminator (and move down - // one) + // Whichever we do it, we write the NUL character (and move down one) *end-- = '\0'; STLSOFT_COVER_MARK_LINE(); @@ -649,7 +648,7 @@ STLSOFT_CLOSE_WORKER_NS_(ximpl_I2S) /** Converts an integer value into a base-36 string representation in the * given character buffer, assigning the number of characters (excluding - * the nul-terminator) written into the given size variable. + * the NUL character) written into the given size variable. * * \tparam T_integer Type of the integer to be converted * \tparam T_character Type of the character array into which the conversion @@ -659,7 +658,7 @@ STLSOFT_CLOSE_WORKER_NS_(ximpl_I2S) * \param cchBuf Number of character available in \c buf * \param i The value to be converted to octal string * \param numWritten Pointer to a variable to receive the number of - * characters written (excluding nul-terminator) + * characters written (excluding NUL character); * * \pre nullptr != buf * \pre cchBuf > integral_format_width_limits::maxHexatridecimalWidth diff --git a/include/stlsoft/conversion/integer_to_string/integer_to_decimal_string.hpp b/include/stlsoft/conversion/integer_to_string/integer_to_decimal_string.hpp index 2b493752..6a118545 100644 --- a/include/stlsoft/conversion/integer_to_string/integer_to_decimal_string.hpp +++ b/include/stlsoft/conversion/integer_to_string/integer_to_decimal_string.hpp @@ -5,11 +5,11 @@ * decimal representation. * * Created: 7th April 2002 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2002-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -56,7 +56,7 @@ # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_DECIMAL_STRING_MAJOR 5 # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_DECIMAL_STRING_MINOR 0 # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_DECIMAL_STRING_REVISION 20 -# define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_DECIMAL_STRING_EDIT 97 +# define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_DECIMAL_STRING_EDIT 98 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -197,8 +197,7 @@ unsigned_integer_to_decimal_string( C* end = buf + (cchBuf - 1); - // Whichever we do it, we write the nul-terminator (and move down - // one) + // Whichever we do it, we write the NUL character (and move down one) *end-- = '\0'; STLSOFT_COVER_MARK_LINE(); @@ -606,13 +605,13 @@ STLSOFT_CLOSE_WORKER_NS_(ximpl_I2S) /** Converts an integer value into a decimal string representation in the * given character buffer, assigning the number of characters (excluding - * the nul-terminator) written into the given size variable. + * the NUL character) written into the given size variable. * * \param buf Pointer to the buffer * \param cchBuf Number of character available in \c buf * \param i The value to be converted to octal string * \param numWritten Pointer to a variable to receive the number of - * characters written (excluding nul-terminator) + * characters written (excluding NUL character); * * \pre nullptr != buf * \pre cchBuf > integral_format_width_limits::maxDecimalWidth diff --git a/include/stlsoft/conversion/integer_to_string/integer_to_hexadecimal_string.hpp b/include/stlsoft/conversion/integer_to_string/integer_to_hexadecimal_string.hpp index 49c5797c..8e9e3b90 100644 --- a/include/stlsoft/conversion/integer_to_string/integer_to_hexadecimal_string.hpp +++ b/include/stlsoft/conversion/integer_to_string/integer_to_hexadecimal_string.hpp @@ -5,11 +5,11 @@ * hexadecimal representation. * * Created: 7th April 2002 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2002-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -56,7 +56,7 @@ # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_HEXADECIMAL_STRING_MAJOR 5 # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_HEXADECIMAL_STRING_MINOR 0 # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_HEXADECIMAL_STRING_REVISION 22 -# define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_HEXADECIMAL_STRING_EDIT 101 +# define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_HEXADECIMAL_STRING_EDIT 102 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -209,8 +209,7 @@ unsigned_integer_to_hexadecimal_string( C* end = buf + (cchBuf - 1); - // Whichever we do it, we write the nul-terminator (and move down - // one) + // Whichever we do it, we write the NUL character (and move down one) *end-- = '\0'; STLSOFT_COVER_MARK_LINE(); @@ -613,13 +612,13 @@ STLSOFT_CLOSE_WORKER_NS_(ximpl_I2S) /** Converts an integer value into a hexadecimal string representation in the * given character buffer, assigning the number of characters (excluding - * the nul-terminator) written into the given size variable. + * the NUL character) written into the given size variable. * * \param buf Pointer to the buffer * \param cchBuf Number of character available in \c buf * \param i The value to be converted to octal string * \param numWritten Pointer to a variable to receive the number of - * characters written (excluding nul-terminator) + * characters written (excluding NUL character); * * \pre nullptr != buf * \pre cchBuf > integral_format_width_limits::maxHexadecimalWidth diff --git a/include/stlsoft/conversion/integer_to_string/integer_to_lc_string.hpp b/include/stlsoft/conversion/integer_to_string/integer_to_lc_string.hpp index 44fa9e03..c4d50547 100644 --- a/include/stlsoft/conversion/integer_to_string/integer_to_lc_string.hpp +++ b/include/stlsoft/conversion/integer_to_string/integer_to_lc_string.hpp @@ -5,11 +5,11 @@ * for decimal representation. * * Created: 1st November 2011 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2011-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -56,7 +56,7 @@ # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_LC_STRING_MAJOR 1 # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_LC_STRING_MINOR 0 # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_LC_STRING_REVISION 13 -# define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_LC_STRING_EDIT 23 +# define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_LC_STRING_EDIT 24 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -98,7 +98,7 @@ namespace stlsoft /** Converts an integer value into a decimal string representation in the * given character buffer with grouping characters according to the given * picture, assigning the number of characters (excluding the - * nul-terminator) written into the given size variable. + * NUL character) written into the given size variable. * * \tparam C1 Character type 1 * \tparam C2 Character type 2 @@ -113,7 +113,7 @@ namespace stlsoft * \param cchDest Size of available buffer. Ignored if dest is \c nullptr; * \param value The number to be converted; * \param numWritten Pointer to a variable to receive the number of - * characters written (excluding nul-terminator) + * characters written (excluding NUL character); * * \pre nullptr != buf * \pre cchBuf > integral_format_width_limits::maxDecimalWidth diff --git a/include/stlsoft/conversion/integer_to_string/integer_to_octal_string.hpp b/include/stlsoft/conversion/integer_to_string/integer_to_octal_string.hpp index 0793fcc8..a9cb1dcd 100644 --- a/include/stlsoft/conversion/integer_to_string/integer_to_octal_string.hpp +++ b/include/stlsoft/conversion/integer_to_string/integer_to_octal_string.hpp @@ -5,11 +5,11 @@ * octal representation. * * Created: 7th April 2002 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2002-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -56,7 +56,7 @@ # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_OCTAL_STRING_MAJOR 5 # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_OCTAL_STRING_MINOR 0 # define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_OCTAL_STRING_REVISION 23 -# define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_OCTAL_STRING_EDIT 102 +# define STLSOFT_VER_STLSOFT_CONVERSION_INTEGER_TO_STRING_HPP_INTEGER_TO_OCTAL_STRING_EDIT 103 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -193,8 +193,7 @@ unsigned_integer_to_octal_string( C* end = buf + (cchBuf - 1); - // Whichever we do it, we write the nul-terminator (and move down - // one) + // Whichever we do it, we write the NUL character (and move down one) *end-- = '\0'; STLSOFT_COVER_MARK_LINE(); @@ -595,13 +594,13 @@ STLSOFT_CLOSE_WORKER_NS_(ximpl_I2S) /** Converts an integer value into an octal string representation in the * given character buffer, assigning the number of characters (excluding - * the nul-terminator) written into the given size variable. + * the NUL character) written into the given size variable. * * \param buf Pointer to the buffer * \param cchBuf Number of character available in \c buf * \param i The value to be converted to octal string * \param numWritten Pointer to a variable to receive the number of - * characters written (excluding nul-terminator) + * characters written (excluding NUL character); * * \pre nullptr != buf * \pre cchBuf > integral_format_width_limits::maxOctalWidth diff --git a/include/stlsoft/conversion/sap_cast.hpp b/include/stlsoft/conversion/sap_cast.hpp index 74e15afa..7e2f9aac 100644 --- a/include/stlsoft/conversion/sap_cast.hpp +++ b/include/stlsoft/conversion/sap_cast.hpp @@ -5,11 +5,11 @@ * the same cv-qualification. * * Created: 25th February 2004 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2004-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -55,7 +55,7 @@ # define STLSOFT_VER_STLSOFT_CONVERSION_HPP_SAP_CAST_MAJOR 4 # define STLSOFT_VER_STLSOFT_CONVERSION_HPP_SAP_CAST_MINOR 0 # define STLSOFT_VER_STLSOFT_CONVERSION_HPP_SAP_CAST_REVISION 8 -# define STLSOFT_VER_STLSOFT_CONVERSION_HPP_SAP_CAST_EDIT 61 +# define STLSOFT_VER_STLSOFT_CONVERSION_HPP_SAP_CAST_EDIT 62 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -131,7 +131,7 @@ short* ps = stlsoft::sap_cast(pi); * * \param from The pointer to cast from. * - * \remarks The cast operator was inspired by an item in the + * \note The cast operator was inspired by an item in the * Sutter/Alexandrescu coding standards book, and its names stands for * Sutter-Alexandrescu-Pointer cast. The acronym is overloaded, since one * might also be said to be a sap if one made injudicious use of the cast, diff --git a/include/stlsoft/diagnostics/std_chrono_hrc_stopwatch.hpp b/include/stlsoft/diagnostics/std_chrono_hrc_stopwatch.hpp index 19902a84..07ffd949 100644 --- a/include/stlsoft/diagnostics/std_chrono_hrc_stopwatch.hpp +++ b/include/stlsoft/diagnostics/std_chrono_hrc_stopwatch.hpp @@ -4,7 +4,7 @@ * Purpose: stopwatch class based on std::chrono::high_resolution_clock. * * Created: 17th March 2024 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * @@ -57,7 +57,7 @@ # define STLSOFT_VER_STLSOFT_DIAGNOSTICS_HPP_STD_CHRONO_HRC_STOPWATCH_MAJOR 1 # define STLSOFT_VER_STLSOFT_DIAGNOSTICS_HPP_STD_CHRONO_HRC_STOPWATCH_MINOR 1 # define STLSOFT_VER_STLSOFT_DIAGNOSTICS_HPP_STD_CHRONO_HRC_STOPWATCH_REVISION 1 -# define STLSOFT_VER_STLSOFT_DIAGNOSTICS_HPP_STD_CHRONO_HRC_STOPWATCH_EDIT 5 +# define STLSOFT_VER_STLSOFT_DIAGNOSTICS_HPP_STD_CHRONO_HRC_STOPWATCH_EDIT 6 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -140,8 +140,8 @@ class std_chrono_hrc_stopwatch void stop(); /// Ends the current measurement period and start the next /// - /// \remarks This is equivalent to an atomic invocation of stop() and - /// start() + /// \note This is equivalent to an atomic invocation of stop() and + /// start(). void restart(); public: // attributes diff --git a/include/stlsoft/filesystem/io_functions/read_line.hpp b/include/stlsoft/filesystem/io_functions/read_line.hpp index 2cd9b0bc..a2f8690a 100644 --- a/include/stlsoft/filesystem/io_functions/read_line.hpp +++ b/include/stlsoft/filesystem/io_functions/read_line.hpp @@ -4,11 +4,11 @@ * Purpose: Definition of stlsoft::read_line() function template. * * Created: 2nd January 2007 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2007-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -55,7 +55,7 @@ # define STLSOFT_VER_STLSOFT_FILESYSTEM_IO_FUNCTIONS_HPP_READ_LINE_MAJOR 3 # define STLSOFT_VER_STLSOFT_FILESYSTEM_IO_FUNCTIONS_HPP_READ_LINE_MINOR 0 # define STLSOFT_VER_STLSOFT_FILESYSTEM_IO_FUNCTIONS_HPP_READ_LINE_REVISION 3 -# define STLSOFT_VER_STLSOFT_FILESYSTEM_IO_FUNCTIONS_HPP_READ_LINE_EDIT 30 +# define STLSOFT_VER_STLSOFT_FILESYSTEM_IO_FUNCTIONS_HPP_READ_LINE_EDIT 31 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -440,7 +440,7 @@ namespace read_line_impl { * \retval true The parsing is not complete * \retval false The parsing is complete * - * \remarks The function can recognise any or all of the following as + * \note The function can recognise any or all of the following as * line-termination sequences: carriage-return ('\\r'), * line-feed ('\\n'), or carriage-return+line-feed * ("\\r\\n"). diff --git a/include/stlsoft/filesystem/path_buffer.hpp b/include/stlsoft/filesystem/path_buffer.hpp index 85eace07..196b45e0 100644 --- a/include/stlsoft/filesystem/path_buffer.hpp +++ b/include/stlsoft/filesystem/path_buffer.hpp @@ -4,11 +4,11 @@ * Purpose: Contains the basic_path_buffer template class. * * Created: 27th May 2020 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2020-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2020-2026, Matthew Wilson and Synesis Information Systems * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -54,7 +54,7 @@ # define STLSOFT_VER_STLSOFT_FILESYSTEM_HPP_PATH_BUFFER_MAJOR 1 # define STLSOFT_VER_STLSOFT_FILESYSTEM_HPP_PATH_BUFFER_MINOR 3 # define STLSOFT_VER_STLSOFT_FILESYSTEM_HPP_PATH_BUFFER_REVISION 5 -# define STLSOFT_VER_STLSOFT_FILESYSTEM_HPP_PATH_BUFFER_EDIT 13 +# define STLSOFT_VER_STLSOFT_FILESYSTEM_HPP_PATH_BUFFER_EDIT 14 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -490,7 +490,7 @@ class basic_path_buffer } /// \return The number of characters written, including the - /// NUL-terminator if included + /// NUL character if included. size_type copy( char_type buffer[] diff --git a/include/stlsoft/iterator/FILE_iterator.hpp b/include/stlsoft/iterator/FILE_iterator.hpp index 13b14e12..3b1ddb3d 100644 --- a/include/stlsoft/iterator/FILE_iterator.hpp +++ b/include/stlsoft/iterator/FILE_iterator.hpp @@ -4,11 +4,11 @@ * Purpose: FILE* output iterator. * * Created: 21st April 2009 - * Updated: 28th May 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2009-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -55,7 +55,7 @@ # define STLSOFT_VER_STLSOFT_ITERATOR_HPP_FILE_ITERATOR_MAJOR 1 # define STLSOFT_VER_STLSOFT_ITERATOR_HPP_FILE_ITERATOR_MINOR 0 # define STLSOFT_VER_STLSOFT_ITERATOR_HPP_FILE_ITERATOR_REVISION 12 -# define STLSOFT_VER_STLSOFT_ITERATOR_HPP_FILE_ITERATOR_EDIT 24 +# define STLSOFT_VER_STLSOFT_ITERATOR_HPP_FILE_ITERATOR_EDIT 25 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -162,8 +162,8 @@ std::copy(ints.begin(), ints.end() * \param T The traits type. Defaults to std::char_traits<C>. * \param S The string type. Defaults to std::basic_string<C>. * - * \remarks The class template avoids fatuous assignment syntax by using the - * \ref group__pattern__dereference_proxy "Dereference Proxy" pattern. + * \note The class template avoids fatuous assignment syntax by using + * the \ref group__pattern__dereference_proxy "Dereference Proxy" pattern. * * \warn There is no protection against a mismatched format string. You must * ensure that the assigned type matches the format string. diff --git a/include/stlsoft/iterators/ostream_iterator.hpp b/include/stlsoft/iterators/ostream_iterator.hpp index 50801332..e063b186 100644 --- a/include/stlsoft/iterators/ostream_iterator.hpp +++ b/include/stlsoft/iterators/ostream_iterator.hpp @@ -4,11 +4,11 @@ * Purpose: Enhanced ostream iterator. * * Created: 16th December 2005 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2005-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -55,7 +55,7 @@ # define STLSOFT_VER_STLSOFT_ITERATORS_HPP_OSTREAM_ITERATOR_MAJOR 1 # define STLSOFT_VER_STLSOFT_ITERATORS_HPP_OSTREAM_ITERATOR_MINOR 3 # define STLSOFT_VER_STLSOFT_ITERATORS_HPP_OSTREAM_ITERATOR_REVISION 12 -# define STLSOFT_VER_STLSOFT_ITERATORS_HPP_OSTREAM_ITERATOR_EDIT 56 +# define STLSOFT_VER_STLSOFT_ITERATORS_HPP_OSTREAM_ITERATOR_EDIT 57 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -147,8 +147,8 @@ std::copy(ints.begin(), ints.end(), stlsoft::ostream_iterator(std::cout, "\ * \param T The traits type. Defaults to std::char_traits<C>. * \param S The string type. Defaults to std::basic_string<C>. * - * \remarks The class template avoids fatuous assignment syntax by using the - * \ref group__pattern__dereference_proxy "Dereference Proxy" pattern. + * \note The class template avoids fatuous assignment syntax by using + * the \ref group__pattern__dereference_proxy "Dereference Proxy" pattern. */ template< ss_typename_param_k V , ss_typename_param_k C = char diff --git a/include/stlsoft/limits/integral_format_width_limits.hpp b/include/stlsoft/limits/integral_format_width_limits.hpp index 3debba08..0d7b1ced 100644 --- a/include/stlsoft/limits/integral_format_width_limits.hpp +++ b/include/stlsoft/limits/integral_format_width_limits.hpp @@ -4,13 +4,13 @@ * Purpose: integral_format_width_limits traits class template. * * Created: 10th July 2012 - * Updated: 28th May 2025 + * Updated: 15th October 2026 * * Thanks: To Jonathan Wakely for help with Solaris compatibility. * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2012-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -57,7 +57,7 @@ # define STLSOFT_VER_STLSOFT_LIMITS_HPP_INTEGRAL_FORMAT_WIDTH_LIMITS_MAJOR 1 # define STLSOFT_VER_STLSOFT_LIMITS_HPP_INTEGRAL_FORMAT_WIDTH_LIMITS_MINOR 1 # define STLSOFT_VER_STLSOFT_LIMITS_HPP_INTEGRAL_FORMAT_WIDTH_LIMITS_REVISION 2 -# define STLSOFT_VER_STLSOFT_LIMITS_HPP_INTEGRAL_FORMAT_WIDTH_LIMITS_EDIT 16 +# define STLSOFT_VER_STLSOFT_LIMITS_HPP_INTEGRAL_FORMAT_WIDTH_LIMITS_EDIT 17 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -99,7 +99,7 @@ namespace stlsoft /// functions such as printf(). /// /// \note The lengths given do not count the -/// nul-terminator character. +/// NUL character character. /// /// \param I The integral type for which the template diff --git a/include/stlsoft/memory/allocator_base.hpp b/include/stlsoft/memory/allocator_base.hpp index 397510fa..81e7001b 100644 --- a/include/stlsoft/memory/allocator_base.hpp +++ b/include/stlsoft/memory/allocator_base.hpp @@ -4,11 +4,11 @@ * Purpose: Allocator commmon features. * * Created: 20th August 2003 - * Updated: 28th July 2026 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2003-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -55,7 +55,7 @@ # define STLSOFT_VER_STLSOFT_MEMORY_HPP_ALLOCATOR_BASE_MAJOR 4 # define STLSOFT_VER_STLSOFT_MEMORY_HPP_ALLOCATOR_BASE_MINOR 1 # define STLSOFT_VER_STLSOFT_MEMORY_HPP_ALLOCATOR_BASE_REVISION 17 -# define STLSOFT_VER_STLSOFT_MEMORY_HPP_ALLOCATOR_BASE_EDIT 71 +# define STLSOFT_VER_STLSOFT_MEMORY_HPP_ALLOCATOR_BASE_EDIT 72 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -134,10 +134,10 @@ namespace stlsoft * winstl::processheap_allocator | * winstl::shell_allocator * - * \remarks This uses the SCTP/CRTP (Simulated Compile-time Polymorphism / Curiously - * Recurring Template Pattern) technique, such that derived classes inherit from - * specialisations of the adaptor template which specify their fully derived - * template-id as the first parameter + * \note This uses the SCTP/CRTP (Simulated Compile-time Polymorphism / + * Curiously Recurring Template Pattern) technique, such that derived + * classes inherit from specialisations of the adaptor template which + * specify their fully derived template-id as the first parameter. * * \note By default, an allocation failure results in a thrown std::bad_alloc. If * the compiler does not throwing std::bad_alloc by default, this behaviour can be @@ -264,8 +264,8 @@ class allocator_base /// The method is functionally identical to /// static_cast(allocate(n, NULL)) /// - /// \remarks This method is only defined when the symbol - /// \ref STLSOFT_CF_ALLOCATOR_CHARALLOC_METHOD is defined. + /// \note This method is only defined when the + /// symbol \ref STLSOFT_CF_ALLOCATOR_CHARALLOC_METHOD is defined. char* _Charalloc(size_type n) { # ifdef STLSOFT_LF_ALLOCATOR_ALLOCATE_HAS_HINT diff --git a/include/stlsoft/memory/auto_buffer.hpp b/include/stlsoft/memory/auto_buffer.hpp index b24e3a44..2c878ec6 100644 --- a/include/stlsoft/memory/auto_buffer.hpp +++ b/include/stlsoft/memory/auto_buffer.hpp @@ -4,7 +4,7 @@ * Purpose: Contains the auto_buffer template class. * * Created: 19th January 2002 - * Updated: 29th June 2025 + * Updated: 15th October 2026 * * Thanks: To Magnificent Imbecil for pointing out error in documentation, * and for suggesting swap() optimisation. To Thorsten Ottosen for @@ -12,7 +12,7 @@ * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2002-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -58,7 +58,7 @@ # define STLSOFT_VER_STLSOFT_MEMORY_HPP_AUTO_BUFFER_MAJOR 5 # define STLSOFT_VER_STLSOFT_MEMORY_HPP_AUTO_BUFFER_MINOR 9 # define STLSOFT_VER_STLSOFT_MEMORY_HPP_AUTO_BUFFER_REVISION 1 -# define STLSOFT_VER_STLSOFT_MEMORY_HPP_AUTO_BUFFER_EDIT 233 +# define STLSOFT_VER_STLSOFT_MEMORY_HPP_AUTO_BUFFER_EDIT 234 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -339,12 +339,12 @@ int pantheios_log_n( * and * shwild. * - * \remarks auto_buffer works correctly whether the given allocator throws + * \note auto_buffer works correctly whether the given allocator throws * an exception on allocation failure, or returns \c nullptr. In the * latter case, construction failure to allocate is reflected by the * size() method returning 0. * - * \remarks The design of auto_buffer is described in Chapter 32 of + * \note The design of auto_buffer is described in Chapter 32 of * Imperfect C++, and its * interface is discussed in detail in Section 16.2 of * Extended STL, volume 1. diff --git a/include/stlsoft/meta/is_class_type.hpp b/include/stlsoft/meta/is_class_type.hpp index ba328a72..8e9b40b7 100644 --- a/include/stlsoft/meta/is_class_type.hpp +++ b/include/stlsoft/meta/is_class_type.hpp @@ -4,11 +4,11 @@ * Purpose: is_class_type meta class. * * Created: 19th November 1998 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2005-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -55,7 +55,7 @@ # define STLSOFT_VER_STLSOFT_META_HPP_IS_CLASS_TYPE_MAJOR 1 # define STLSOFT_VER_STLSOFT_META_HPP_IS_CLASS_TYPE_MINOR 0 # define STLSOFT_VER_STLSOFT_META_HPP_IS_CLASS_TYPE_REVISION 7 -# define STLSOFT_VER_STLSOFT_META_HPP_IS_CLASS_TYPE_EDIT 22 +# define STLSOFT_VER_STLSOFT_META_HPP_IS_CLASS_TYPE_EDIT 23 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -128,15 +128,15 @@ two_t is_class_type_func(...); /** Traits type used to determine whether the given type is * of class type. * - * \remarks Compatibility: - * - Borland C/C++ 5.6 compiles but thinks everything is a class type - * - CodePlay compiles but thinks that nothing is a class type - * - Comeau works with most things (not references) - * - CodeWarrior 3.0+ compiles and works from version 8 onwards - * - Digital Mars 8.40+ compiles and works with most things (not references) - * - GCC works with most things (not references) - * - Intel works with most things (not references) - * - Visual C++ compiles and works from version 7.1 onwards with most things (not references) + * \note Compatibility: + * - Borland C/C++ 5.6 compiles but thinks everything is a class type; + * - CodePlay compiles but thinks that nothing is a class type; + * - Comeau works with most things (not references); + * - CodeWarrior 3.0+ compiles and works from version 8 onwards; + * - Digital Mars 8.40+ compiles and works with most things (not references); + * - GCC works with most things (not references); + * - Intel works with most things (not references); + * - Visual C++ compiles and works from version 7.1 onwards with most things (not references); * * \ingroup group__library__Metaprogramming */ diff --git a/include/stlsoft/obsolete/proxy_iterator.hpp b/include/stlsoft/obsolete/proxy_iterator.hpp index 8c2eefed..45c5b574 100644 --- a/include/stlsoft/obsolete/proxy_iterator.hpp +++ b/include/stlsoft/obsolete/proxy_iterator.hpp @@ -4,11 +4,11 @@ * Purpose: proxy_iterator template class. * * Created: 28th June 2004 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2004-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -52,7 +52,7 @@ # define STLSOFT_VER_STLSOFT_OBSOLETE_HPP_PROXY_ITERATOR_MAJOR 3 # define STLSOFT_VER_STLSOFT_OBSOLETE_HPP_PROXY_ITERATOR_MINOR 0 # define STLSOFT_VER_STLSOFT_OBSOLETE_HPP_PROXY_ITERATOR_REVISION 6 -# define STLSOFT_VER_STLSOFT_OBSOLETE_HPP_PROXY_ITERATOR_EDIT 66 +# define STLSOFT_VER_STLSOFT_OBSOLETE_HPP_PROXY_ITERATOR_EDIT 67 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -110,7 +110,7 @@ namespace stlsoft * \param R The reference type * \param P The pointer type * - * \remarks Iterator for proxy_sequence + * \note Iterator for proxy_sequence. * * \deprecated This is maintained for backwards compatibility with the * recls/COM library. New users should instead use diff --git a/include/stlsoft/shims/access/string/std/exception.hpp b/include/stlsoft/shims/access/string/std/exception.hpp index 3444e51b..f1e8d740 100644 --- a/include/stlsoft/shims/access/string/std/exception.hpp +++ b/include/stlsoft/shims/access/string/std/exception.hpp @@ -4,11 +4,11 @@ * Purpose: Contains the string access shims for std::exception. * * Created: 2nd May 2003 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2003-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -55,7 +55,7 @@ # define _STLSOFT_VER_STLSOFT_SHIMS_ACCESS_STRING_STD_HPP_EXCEPTION_MAJOR 2 # define _STLSOFT_VER_STLSOFT_SHIMS_ACCESS_STRING_STD_HPP_EXCEPTION_MINOR 2 # define _STLSOFT_VER_STLSOFT_SHIMS_ACCESS_STRING_STD_HPP_EXCEPTION_REVISION 15 -# define _STLSOFT_VER_STLSOFT_SHIMS_ACCESS_STRING_STD_HPP_EXCEPTION_EDIT 61 +# define _STLSOFT_VER_STLSOFT_SHIMS_ACCESS_STRING_STD_HPP_EXCEPTION_EDIT 62 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -123,7 +123,7 @@ struct ximpl_stlsoft_shims_access_string_std_exception_ { public: // - // *numConverted excludes the nul-terminator + // *numConverted excludes the NUL character static int mbstowcs_( @@ -146,7 +146,7 @@ struct ximpl_stlsoft_shims_access_string_std_exception_ { STLSOFT_ASSERT(0 != *numConverted); - --*numConverted; // mbstowcs_s() always adds one for nul-terminator + --*numConverted; // mbstowcs_s() always adds one for NUL character } return r; @@ -167,7 +167,7 @@ struct ximpl_stlsoft_shims_access_string_std_exception_ } // - // *numConverted excludes the nul-terminator + // *numConverted excludes the NUL character static int mbstowcs_len( @@ -185,7 +185,7 @@ struct ximpl_stlsoft_shims_access_string_std_exception_ { STLSOFT_ASSERT(0 != *len); - --*len; // mbstowcs_s() always adds one for nul-terminator + --*len; // mbstowcs_s() always adds one for NUL character } return r; diff --git a/include/stlsoft/shims/access/string/std/type_info.hpp b/include/stlsoft/shims/access/string/std/type_info.hpp index 2d413b53..c50627cb 100644 --- a/include/stlsoft/shims/access/string/std/type_info.hpp +++ b/include/stlsoft/shims/access/string/std/type_info.hpp @@ -4,11 +4,11 @@ * Purpose: Contains the string access shims for std::type_info. * * Created: 19th December 2011 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2011-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -55,7 +55,7 @@ # define _STLSOFT_VER_STLSOFT_SHIMS_ACCESS_STRING_STD_HPP_TYPE_INFO_MAJOR 2 # define _STLSOFT_VER_STLSOFT_SHIMS_ACCESS_STRING_STD_HPP_TYPE_INFO_MINOR 3 # define _STLSOFT_VER_STLSOFT_SHIMS_ACCESS_STRING_STD_HPP_TYPE_INFO_REVISION 4 -# define _STLSOFT_VER_STLSOFT_SHIMS_ACCESS_STRING_STD_HPP_TYPE_INFO_EDIT 58 +# define _STLSOFT_VER_STLSOFT_SHIMS_ACCESS_STRING_STD_HPP_TYPE_INFO_EDIT 59 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -130,7 +130,7 @@ struct ximpl_stlsoft_shims_access_string_std_type_info_ { public: // - // *numConverted excludes the nul-terminator + // *numConverted excludes the NUL character static int mbstowcs_( @@ -141,7 +141,7 @@ struct ximpl_stlsoft_shims_access_string_std_type_info_ , ss_size_t* numConverted ) { - // Always assume the nul-terminator + // Always assume the NUL character STLSOFT_ASSERT(NULL != mbs); STLSOFT_ASSERT(NULL != numConverted); @@ -154,7 +154,7 @@ struct ximpl_stlsoft_shims_access_string_std_type_info_ { STLSOFT_ASSERT(0 != *numConverted); - --*numConverted; // mbstowcs_s() always adds one for nul-terminator + --*numConverted; // mbstowcs_s() always adds one for NUL character } return r; @@ -175,7 +175,7 @@ struct ximpl_stlsoft_shims_access_string_std_type_info_ } // - // *numConverted excludes the nul-terminator + // *numConverted excludes the NUL character static int mbstowcs_len( @@ -193,7 +193,7 @@ struct ximpl_stlsoft_shims_access_string_std_type_info_ { STLSOFT_ASSERT(0 != *len); - --*len; // mbstowcs_s() always adds one for nul-terminator + --*len; // mbstowcs_s() always adds one for NUL character } return r; diff --git a/include/stlsoft/smartptr/scoped_handle/scoped_handle_cc.hpp b/include/stlsoft/smartptr/scoped_handle/scoped_handle_cc.hpp index 4a854a55..1998494b 100644 --- a/include/stlsoft/smartptr/scoped_handle/scoped_handle_cc.hpp +++ b/include/stlsoft/smartptr/scoped_handle/scoped_handle_cc.hpp @@ -5,13 +5,13 @@ * types. * * Created: 1st November 1994 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Thanks: Adi Shavit, for requesting the indirect functionality * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 1994-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -58,7 +58,7 @@ # define STLSOFT_VER_STLSOFT_SMARTPTR_SCOPED_HANDLE_HPP_SCOPED_HANDLE_CC_MAJOR 5 # define STLSOFT_VER_STLSOFT_SMARTPTR_SCOPED_HANDLE_HPP_SCOPED_HANDLE_CC_MINOR 7 # define STLSOFT_VER_STLSOFT_SMARTPTR_SCOPED_HANDLE_HPP_SCOPED_HANDLE_CC_REVISION 3 -# define STLSOFT_VER_STLSOFT_SMARTPTR_SCOPED_HANDLE_HPP_SCOPED_HANDLE_CC_EDIT 694 +# define STLSOFT_VER_STLSOFT_SMARTPTR_SCOPED_HANDLE_HPP_SCOPED_HANDLE_CC_EDIT 695 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -618,7 +618,7 @@ class scoped_handle /// Detaches the resource, and returns it to the caller. /// - /// \remarks Calling this method removes the resource from the managing + /// \note Calling this method removes the resource from the managing /// instance, so it will not be automatically closed. resource_type detach() STLSOFT_NOEXCEPT { @@ -834,7 +834,7 @@ class scoped_handle /// Detaches the resource, and returns it to the caller. /// - /// \remarks Calling this method removes the resource from the managing + /// \note Calling this method removes the resource from the managing /// instance, so it will not be automatically closed. resource_type detach() STLSOFT_NOEXCEPT { diff --git a/include/stlsoft/string/char_traits.hpp b/include/stlsoft/string/char_traits.hpp index b7a81bbf..8c645f0b 100644 --- a/include/stlsoft/string/char_traits.hpp +++ b/include/stlsoft/string/char_traits.hpp @@ -4,7 +4,7 @@ * Purpose: char_traits classes. * * Created: 19th November 1998 - * Updated: 29th September 2026 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * @@ -55,7 +55,7 @@ # define STLSOFT_VER_STLSOFT_STRING_HPP_CHAR_TRAITS_MAJOR 4 # define STLSOFT_VER_STLSOFT_STRING_HPP_CHAR_TRAITS_MINOR 3 # define STLSOFT_VER_STLSOFT_STRING_HPP_CHAR_TRAITS_REVISION 3 -# define STLSOFT_VER_STLSOFT_STRING_HPP_CHAR_TRAITS_EDIT 102 +# define STLSOFT_VER_STLSOFT_STRING_HPP_CHAR_TRAITS_EDIT 103 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -266,7 +266,7 @@ struct stlsoft_char_traits } /// Compares up to \c cch characters of \c s1 with \c, stopping at the - /// first difference or until the NUL-terminator is reached + /// first difference or until the NUL character is reached. /// /// \param s1 The first string to compare /// \param s2 The second string to compare diff --git a/include/stlsoft/string/cstring_maker.hpp b/include/stlsoft/string/cstring_maker.hpp index 08a2fcb2..37ca28e3 100644 --- a/include/stlsoft/string/cstring_maker.hpp +++ b/include/stlsoft/string/cstring_maker.hpp @@ -4,11 +4,11 @@ * Purpose: Simple utility class for creating (constant) C-strings. * * Created: 14th May 2004 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2004-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -54,7 +54,7 @@ # define STLSOFT_VER_STLSOFT_STRING_HPP_CSTRING_MAKER_MAJOR 5 # define STLSOFT_VER_STLSOFT_STRING_HPP_CSTRING_MAKER_MINOR 0 # define STLSOFT_VER_STLSOFT_STRING_HPP_CSTRING_MAKER_REVISION 6 -# define STLSOFT_VER_STLSOFT_STRING_HPP_CSTRING_MAKER_EDIT 68 +# define STLSOFT_VER_STLSOFT_STRING_HPP_CSTRING_MAKER_EDIT 69 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -194,7 +194,7 @@ struct cstring_maker public: /// Allocates storage for writing into a string, optionally initialising /// - /// \note Includes space for a nul-terminator character + /// \note Includes space for a NUL character character. /// /// \param s The optional string to be copied into the block. May be /// \c null; if not, must be of at least \c cch characters long @@ -254,7 +254,7 @@ struct cstring_maker /// Allocates storage for writing into a string, optionally /// initialising, or returns \c nullptr if \c cch is 0 /// - /// \note Includes space for a nul-terminator character + /// \note Includes space for a NUL character character. /// /// \param s The optional string to be copied into the block. May be /// \c null; if not, must be of at least \c cch characters long diff --git a/include/stlsoft/string/shim_string.hpp b/include/stlsoft/string/shim_string.hpp index 6e330cb1..8e5bfeb1 100644 --- a/include/stlsoft/string/shim_string.hpp +++ b/include/stlsoft/string/shim_string.hpp @@ -4,13 +4,13 @@ * Purpose: Contains the basic_shim_string template class. * * Created: 9th July 2004 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Thanks: Dimitri Kaparis, for spotting a typo in the string access shims. * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2004-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -57,7 +57,7 @@ # define STLSOFT_VER_STLSOFT_STRING_HPP_SHIM_STRING_MAJOR 3 # define STLSOFT_VER_STLSOFT_STRING_HPP_SHIM_STRING_MINOR 7 # define STLSOFT_VER_STLSOFT_STRING_HPP_SHIM_STRING_REVISION 4 -# define STLSOFT_VER_STLSOFT_STRING_HPP_SHIM_STRING_EDIT 74 +# define STLSOFT_VER_STLSOFT_STRING_HPP_SHIM_STRING_EDIT 76 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -199,7 +199,7 @@ class basic_shim_string public: /// Creates an empty instance /// - /// \remarks the 0th element is assigned the nul terminator + /// \note the 0th element is assigned the NUL character. basic_shim_string() : m_len(0) , m_buffer(1) @@ -214,8 +214,8 @@ class basic_shim_string /// Creates an instance with the given number of characters /// - /// \remarks the 0th and nth elements are assigned - /// the nul terminator + /// \note the 0th and nth elements are assigned the + /// NUL character. ss_explicit_k basic_shim_string( size_type n @@ -235,7 +235,7 @@ class basic_shim_string /// Creates an instance containing the given number of characters from /// the given string /// - /// \remarks the nth element is assigned the nul terminator + /// \note the nth element is assigned the NUL character. basic_shim_string( char_type const* s , size_type n @@ -422,7 +422,7 @@ class basic_shim_string } /// Changes the size of the storage to at least the given size, and - /// applies the nul-terminator + /// applies the NUL character. /// /// \note No elements in the range [0, n) are affected, which means that /// the string may contain embedded nuls. It is entirely the user's diff --git a/include/stlsoft/string/simple_string.hpp b/include/stlsoft/string/simple_string.hpp index b9c2c132..2b688549 100644 --- a/include/stlsoft/string/simple_string.hpp +++ b/include/stlsoft/string/simple_string.hpp @@ -4,7 +4,7 @@ * Purpose: basic_simple_string class template. * * Created: 19th March 1993 - * Updated: 29th September 2026 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * @@ -55,7 +55,7 @@ # define STLSOFT_VER_STLSOFT_STRING_HPP_SIMPLE_STRING_MAJOR 5 # define STLSOFT_VER_STLSOFT_STRING_HPP_SIMPLE_STRING_MINOR 0 # define STLSOFT_VER_STLSOFT_STRING_HPP_SIMPLE_STRING_REVISION 1 -# define STLSOFT_VER_STLSOFT_STRING_HPP_SIMPLE_STRING_EDIT 287 +# define STLSOFT_VER_STLSOFT_STRING_HPP_SIMPLE_STRING_EDIT 288 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -1747,7 +1747,7 @@ basic_simple_string::alloc_buffer_( ss_size_t const members = (STLSOFT_RAW_OFFSETOF(string_buffer, contents) + (sizeof(char_type) - 1)) / sizeof(char_type); - capacity += 1; // for NUL-terminator + capacity += 1; // for NUL character capacity += members; // include the internal members. capacity = (alloc_quantum + capacity) & ~alloc_quantum; // round up to (alloc_quantum + 1) @@ -3036,7 +3036,7 @@ inline ss_typename_type_ret_k basic_simple_string::const_reference basic_simple_string::operator [](ss_typename_type_k basic_simple_string::size_type index) const STLSOFT_NOEXCEPT { - STLSOFT_MESSAGE_ASSERT("index access out of range in simple_string", index < size() + 1); // Valid to return (const) reference to NUL-terminator + STLSOFT_MESSAGE_ASSERT("index access out of range in simple_string", index < size() + 1); // Valid to return (const) reference to NUL character STLSOFT_ASSERT(is_valid()); diff --git a/include/stlsoft/string/static_string.hpp b/include/stlsoft/string/static_string.hpp index 550ec376..51e7327f 100644 --- a/include/stlsoft/string/static_string.hpp +++ b/include/stlsoft/string/static_string.hpp @@ -4,7 +4,7 @@ * Purpose: basic_static_string class template. * * Created: 11th June 1994 - * Updated: 31st July 2026 + * Updated: 15th October 2026 * * Thanks: To Cláudio Albuquerque for supplying the pop_back() member. * @@ -57,7 +57,7 @@ # define STLSOFT_VER_STLSOFT_STRING_HPP_STATIC_STRING_MAJOR 5 # define STLSOFT_VER_STLSOFT_STRING_HPP_STATIC_STRING_MINOR 5 # define STLSOFT_VER_STLSOFT_STRING_HPP_STATIC_STRING_REVISION 3 -# define STLSOFT_VER_STLSOFT_STRING_HPP_STATIC_STRING_EDIT 233 +# define STLSOFT_VER_STLSOFT_STRING_HPP_STATIC_STRING_EDIT 234 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -2434,7 +2434,7 @@ inline ss_typename_type_ret_k basic_static_string::const_reference basic_static_string::operator [](ss_typename_type_k basic_static_string::size_type index) const STLSOFT_NOEXCEPT { - STLSOFT_MESSAGE_ASSERT("index access out of range in static_string", index < size() + 1); // Valid to return (const) reference to nul-terminator + STLSOFT_MESSAGE_ASSERT("index access out of range in static_string", index < size() + 1); // Valid to return (const) reference to NUL character STLSOFT_ASSERT(is_valid()); diff --git a/include/stlsoft/time/fast_strftime.hpp b/include/stlsoft/time/fast_strftime.hpp index c5b3e956..2d67e1d1 100644 --- a/include/stlsoft/time/fast_strftime.hpp +++ b/include/stlsoft/time/fast_strftime.hpp @@ -4,11 +4,11 @@ * Purpose: Efficient drop-in replacement for strftime(). * * Created: 23rd December 2018 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2018-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -55,7 +55,7 @@ # define STLSOFT_VER_STLSOFT_TIME_HPP_FAST_STRFTIME_MAJOR 1 # define STLSOFT_VER_STLSOFT_TIME_HPP_FAST_STRFTIME_MINOR 3 # define STLSOFT_VER_STLSOFT_TIME_HPP_FAST_STRFTIME_REVISION 1 -# define STLSOFT_VER_STLSOFT_TIME_HPP_FAST_STRFTIME_EDIT 17 +# define STLSOFT_VER_STLSOFT_TIME_HPP_FAST_STRFTIME_EDIT 18 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -1095,7 +1095,7 @@ fast_strftime_( * \pre nullptr != tm * \pre 0 == cchDest || nullptr != dest * - * \remarks The following formatting codes (supported by VC++ 6) are supported: + * \note The following formatting codes (supported by VC++ 6) are supported: * \li \c \% - a percent sign * \li \c a - weekday name (abbreviated) * \li \c A - weekday name (full) @@ -1116,7 +1116,8 @@ fast_strftime_( * \li \c y - year without century, as decimal number [0-99] * \li \c Y - year with century, as decimal number * - * \remarks The following formatting codes (supported by VC++ 10) are supported: + * \note The following formatting codes (supported by VC++ 10) are + * supported: * \li \c D - equivalent to "%m/%d/%y" * \li \c e - day of month as space-padded decimal number [ 1-31] * \li \c F - equivalent to "%Y-%m-%d" @@ -1126,7 +1127,7 @@ fast_strftime_( * \li \c T - equivalent to "%H:%M:%S" * \li \c u - weekday, with Monday as 1, as decimal number [1-7] * - * \remarks The following formatting codes are not supported + * \note The following formatting codes are not supported * \li \c c - * \li \c g - * \li \c G - @@ -1138,7 +1139,7 @@ fast_strftime_( * \li \c z - * \li \c Z - * - * \remarks The following supported codes are modified by the '#' + * \note The following supported codes are modified by the '#' * character - e.g. "%#d" - to remove leading 0, if any: * \li \c d * \li \c D @@ -1158,7 +1159,7 @@ fast_strftime_( * \li \c y * \li \c Y * - * \remarks The following supported codes are unmodified by the '#' + * \note The following supported codes are unmodified by the '#' * character - e.g. "%#a": * \li \c \% * \li \c a diff --git a/include/stlsoft/util/exception_string.hpp b/include/stlsoft/util/exception_string.hpp index 0dbe9d21..c85a7681 100644 --- a/include/stlsoft/util/exception_string.hpp +++ b/include/stlsoft/util/exception_string.hpp @@ -4,11 +4,11 @@ * Purpose: Contains the exception_string limited functionality string class. * * Created: 26th December 2005 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2005-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -54,7 +54,7 @@ # define STLSOFT_VER_STLSOFT_UTIL_HPP_EXCEPTION_STRING_MAJOR 1 # define STLSOFT_VER_STLSOFT_UTIL_HPP_EXCEPTION_STRING_MINOR 4 # define STLSOFT_VER_STLSOFT_UTIL_HPP_EXCEPTION_STRING_REVISION 10 -# define STLSOFT_VER_STLSOFT_UTIL_HPP_EXCEPTION_STRING_EDIT 39 +# define STLSOFT_VER_STLSOFT_UTIL_HPP_EXCEPTION_STRING_EDIT 40 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -196,8 +196,8 @@ class exception_string /// /// \param n The length to which the string's contents will be truncated /// - /// \remarks This method is a no-op if the length specified is greater - /// than the current length + /// \note This method is a no-op if the length specified is greater than + /// the current length. void truncate(size_type n) { if (n < m_message.size() - 1) diff --git a/include/stlsoft/util/exception_string_creator.hpp b/include/stlsoft/util/exception_string_creator.hpp index b7bc3983..103e220c 100644 --- a/include/stlsoft/util/exception_string_creator.hpp +++ b/include/stlsoft/util/exception_string_creator.hpp @@ -4,11 +4,11 @@ * Purpose: Contains the exception_string_creator class. * * Created: 25th May 2010 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2010-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -54,7 +54,7 @@ # define STLSOFT_VER_STLSOFT_UTIL_HPP_EXCEPTION_STRING_CREATOR_MAJOR 1 # define STLSOFT_VER_STLSOFT_UTIL_HPP_EXCEPTION_STRING_CREATOR_MINOR 1 # define STLSOFT_VER_STLSOFT_UTIL_HPP_EXCEPTION_STRING_CREATOR_REVISION 11 -# define STLSOFT_VER_STLSOFT_UTIL_HPP_EXCEPTION_STRING_CREATOR_EDIT 32 +# define STLSOFT_VER_STLSOFT_UTIL_HPP_EXCEPTION_STRING_CREATOR_EDIT 34 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -211,8 +211,8 @@ class basic_exception_string_creator /// /// \param n The length to which the string's contents will be truncated /// - /// \remarks This method is a no-op if the length specified is greater - /// than the current length + /// \note This method is a no-op if the length specified is greater than + /// the current length. class_type& truncate(size_type n) { if (n < m_message.size()) @@ -477,7 +477,7 @@ class basic_exception_string_creator if (0 == err) { - // wcstombs_s() always included nul-terminator in count + // wcstombs_s() always included NUL character in count --numConverted; } else diff --git a/include/stlsoft/util/must_init.hpp b/include/stlsoft/util/must_init.hpp index 38639f38..b2bf656f 100644 --- a/include/stlsoft/util/must_init.hpp +++ b/include/stlsoft/util/must_init.hpp @@ -9,11 +9,11 @@ * coverage. * * Created: 18th June 2006 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2006-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -59,7 +59,7 @@ # define STLSOFT_VER_STLSOFT_UTIL_HPP_MUST_INIT_MAJOR 1 # define STLSOFT_VER_STLSOFT_UTIL_HPP_MUST_INIT_MINOR 1 # define STLSOFT_VER_STLSOFT_UTIL_HPP_MUST_INIT_REVISION 9 -# define STLSOFT_VER_STLSOFT_UTIL_HPP_MUST_INIT_EDIT 32 +# define STLSOFT_VER_STLSOFT_UTIL_HPP_MUST_INIT_EDIT 33 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -192,7 +192,7 @@ class must_init_builtin public: /// The underlying value /// - /// \remarks Since the purpose of must_init is to guard against a + /// \note Since the purpose of must_init is to guard against a /// forgotten initialisation in composition involving fundamental /// types, rather than encapsulation in any wider sense, the member /// value is public, to simplify manipulation of the actual value by @@ -274,7 +274,7 @@ class must_init public: /// The underlying value /// - /// \remarks Since the purpose of must_init is to guard against a + /// \note Since the purpose of must_init is to guard against a /// forgotten initialisation in composition involving fundamental /// types, rather than encapsulation in any wider sense, the member /// value is public, to simplify manipulation of the actual value by diff --git a/include/stlsoft/util/printf_traits.hpp b/include/stlsoft/util/printf_traits.hpp index a900c81a..56f1e90d 100644 --- a/include/stlsoft/util/printf_traits.hpp +++ b/include/stlsoft/util/printf_traits.hpp @@ -4,11 +4,11 @@ * Purpose: printf_traits classes. * * Created: 16th January 2002 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2002-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -55,7 +55,7 @@ # define STLSOFT_VER_STLSOFT_UTIL_HPP_PRINTF_TRAITS_MAJOR 5 # define STLSOFT_VER_STLSOFT_UTIL_HPP_PRINTF_TRAITS_MINOR 0 # define STLSOFT_VER_STLSOFT_UTIL_HPP_PRINTF_TRAITS_REVISION 5 -# define STLSOFT_VER_STLSOFT_UTIL_HPP_PRINTF_TRAITS_EDIT 75 +# define STLSOFT_VER_STLSOFT_UTIL_HPP_PRINTF_TRAITS_EDIT 76 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -162,7 +162,7 @@ namespace stlsoft * printf_traits is a traits class for acquiring enum values representing the * lengths, when expressed in string form, of the minimum and maximum values of * the type, and the maximum of the two. The lengths are inclusive of the - * null terminator. + * NUL character. * \code assert(stlsoft::printf_traits::size_min == 6); diff --git a/include/stlsoft/util/true_typedef.hpp b/include/stlsoft/util/true_typedef.hpp index 156ce2ae..6f8ed407 100644 --- a/include/stlsoft/util/true_typedef.hpp +++ b/include/stlsoft/util/true_typedef.hpp @@ -4,11 +4,11 @@ * Purpose: Contains the true_typedef class template. * * Created: 16th January 2002 - * Updated: 21st March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2002-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -54,7 +54,7 @@ # define STLSOFT_VER_STLSOFT_UTIL_HPP_TRUE_TYPEDEF_MAJOR 4 # define STLSOFT_VER_STLSOFT_UTIL_HPP_TRUE_TYPEDEF_MINOR 3 # define STLSOFT_VER_STLSOFT_UTIL_HPP_TRUE_TYPEDEF_REVISION 1 -# define STLSOFT_VER_STLSOFT_UTIL_HPP_TRUE_TYPEDEF_EDIT 97 +# define STLSOFT_VER_STLSOFT_UTIL_HPP_TRUE_TYPEDEF_EDIT 98 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -123,8 +123,8 @@ namespace stlsoft * \tparam T The base type, e.g. \c int, \c std::wstring * \tparam U The unique type, usually created by using STLSOFT_GEN_OPAQUE() * - * \remarks U is the unique type, and is usually a type generated by the - * STLSOFT_GEN_OPAQUE() macro, as in: + * \note U is the unique type, and is usually a type generated by the + * STLSOFT_GEN_OPAQUE() macro, as in: \code STLSOFT_GEN_OPAQUE(h_uniquelong_tt) typedef true_typedef uniquelong_tt; diff --git a/include/unixstl/diagnostics/stopwatch.hpp b/include/unixstl/diagnostics/stopwatch.hpp index 708ca450..a1c5a1c9 100644 --- a/include/unixstl/diagnostics/stopwatch.hpp +++ b/include/unixstl/diagnostics/stopwatch.hpp @@ -4,11 +4,11 @@ * Purpose: stopwatch class. * * Created: 16th January 2002 - * Updated: 28th April 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2002-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -55,7 +55,7 @@ # define UNIXSTL_VER_UNIXSTL_DIAGNOSTICS_HPP_STOPWATCH_MAJOR 5 # define UNIXSTL_VER_UNIXSTL_DIAGNOSTICS_HPP_STOPWATCH_MINOR 2 # define UNIXSTL_VER_UNIXSTL_DIAGNOSTICS_HPP_STOPWATCH_REVISION 3 -# define UNIXSTL_VER_UNIXSTL_DIAGNOSTICS_HPP_STOPWATCH_EDIT 84 +# define UNIXSTL_VER_UNIXSTL_DIAGNOSTICS_HPP_STOPWATCH_EDIT 85 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -150,8 +150,8 @@ class stopwatch void stop(); /// Ends the current measurement period and start the next /// - /// \remarks This is equivalent to an atomic invocation of stop() and - /// start() + /// \note This is equivalent to an atomic invocation of stop() and + /// start(). void restart(); diff --git a/include/unixstl/filesystem/filesystem_traits.hpp b/include/unixstl/filesystem/filesystem_traits.hpp index c392cdd0..e3813454 100644 --- a/include/unixstl/filesystem/filesystem_traits.hpp +++ b/include/unixstl/filesystem/filesystem_traits.hpp @@ -5,7 +5,7 @@ * Unicode specialisations thereof. * * Created: 15th November 2002 - * Updated: 8th October 2026 + * Updated: 15th October 2026 * * Thanks: To Sergey Nikulov, for spotting a preprocessor typo that broke * GCC -pedantic; to Michal Makowski and Zar Eindl for reporting @@ -61,7 +61,7 @@ # define UNIXSTL_VER_UNIXSTL_FILESYSTEM_HPP_FILESYSTEM_TRAITS_MAJOR 4 # define UNIXSTL_VER_UNIXSTL_FILESYSTEM_HPP_FILESYSTEM_TRAITS_MINOR 17 # define UNIXSTL_VER_UNIXSTL_FILESYSTEM_HPP_FILESYSTEM_TRAITS_REVISION 1 -# define UNIXSTL_VER_UNIXSTL_FILESYSTEM_HPP_FILESYSTEM_TRAITS_EDIT 190 +# define UNIXSTL_VER_UNIXSTL_FILESYSTEM_HPP_FILESYSTEM_TRAITS_EDIT 191 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -332,7 +332,7 @@ struct filesystem_traits /// \pre nullptr != dir /// /// \note \c dir is assumed to contain space for an additional - /// character (if required) and NUL-terminator + /// character (if required) and NUL character. /// /// \see \link #path_name_separator path_name_separator() \endlink static diff --git a/include/unixstl/filesystem/path.hpp b/include/unixstl/filesystem/path.hpp index b8b2f94f..c8c8c89d 100644 --- a/include/unixstl/filesystem/path.hpp +++ b/include/unixstl/filesystem/path.hpp @@ -4,14 +4,14 @@ * Purpose: Simple class that represents a path. * * Created: 1st May 1993 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Thanks: Pablo Aguilar for reporting defect in push_ext() (which doesn't * work for wide-string builds). * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 1993-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -57,7 +57,7 @@ # define UNIXSTL_VER_UNIXSTL_FILESYSTEM_HPP_PATH_MAJOR 7 # define UNIXSTL_VER_UNIXSTL_FILESYSTEM_HPP_PATH_MINOR 1 # define UNIXSTL_VER_UNIXSTL_FILESYSTEM_HPP_PATH_REVISION 8 -# define UNIXSTL_VER_UNIXSTL_FILESYSTEM_HPP_PATH_EDIT 282 +# define UNIXSTL_VER_UNIXSTL_FILESYSTEM_HPP_PATH_EDIT 283 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -417,7 +417,7 @@ class basic_path size_type length() const STLSOFT_NOEXCEPT; /// Returns the length of the converted path /// - /// \remarks Equivalent to length() + /// \note Equivalent to length(). size_type size() const STLSOFT_NOEXCEPT; /// The maximum possible length of a path static size_type max_size() STLSOFT_NOEXCEPT; @@ -465,7 +465,7 @@ class basic_path /// Evaluates whether the two instances hold strings that refer /// to the same file-system entity. /// - /// \remarks See \link winstl::basic_path::equivalent(C const* ) equivalent()\endlink for an example. + /// \note See \link winstl::basic_path::equivalent(C const* ) equivalent()\endlink for an example. /// /// \note The string comparison is case-insensitive. bool_type equivalent(class_type const& rhs) const STLSOFT_NOEXCEPT; diff --git a/include/winstl/diagnostics/stopwatch.hpp b/include/winstl/diagnostics/stopwatch.hpp index 5fa39ee2..65094643 100644 --- a/include/winstl/diagnostics/stopwatch.hpp +++ b/include/winstl/diagnostics/stopwatch.hpp @@ -6,11 +6,11 @@ * otherwise using the tick-count facilities. * * Created: 31st July 2002 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2002-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -57,7 +57,7 @@ # define WINSTL_VER_WINSTL_DIAGNOSTICS_HPP_STOPWATCH_MAJOR 5 # define WINSTL_VER_WINSTL_DIAGNOSTICS_HPP_STOPWATCH_MINOR 1 # define WINSTL_VER_WINSTL_DIAGNOSTICS_HPP_STOPWATCH_REVISION 2 -# define WINSTL_VER_WINSTL_DIAGNOSTICS_HPP_STOPWATCH_EDIT 54 +# define WINSTL_VER_WINSTL_DIAGNOSTICS_HPP_STOPWATCH_EDIT 55 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -158,10 +158,10 @@ std::cout << "Number of nanoseconds: " << static_cast(sw.get_nan \endcode * * - * \remarks This class attempts to use the high performance hardware - * stopwatch as its measurement resource, but failing that it defaults to - * less accurate resources in order to guarantee that meaningful - * measurements are always available to application code. + * \note This class attempts to use the high performance hardware stopwatch + * as its measurement resource, but failing that it defaults to less + * accurate resources in order to guarantee that meaningful measurements + * are always available to application code. */ class stopwatch { @@ -221,8 +221,8 @@ class stopwatch void stop(); /// Ends the current measurement period and start the next /// - /// \remarks This is equivalent to an atomic invocation of stop() and - /// start() + /// \note This is equivalent to an atomic invocation of stop() and + /// start(). void restart(); public: // attributes diff --git a/include/winstl/filesystem/file_functions.hpp b/include/winstl/filesystem/file_functions.hpp index e7463a13..07a14e7b 100644 --- a/include/winstl/filesystem/file_functions.hpp +++ b/include/winstl/filesystem/file_functions.hpp @@ -4,11 +4,11 @@ * Purpose: Helper functions for file handling * * Created: 1st January 2005 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2005-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -54,7 +54,7 @@ # define WINSTL_VER_WINSTL_FILESYSTEM_HPP_FILE_FUNCTIONS_MAJOR 2 # define WINSTL_VER_WINSTL_FILESYSTEM_HPP_FILE_FUNCTIONS_MINOR 3 # define WINSTL_VER_WINSTL_FILESYSTEM_HPP_FILE_FUNCTIONS_REVISION 19 -# define WINSTL_VER_WINSTL_FILESYSTEM_HPP_FILE_FUNCTIONS_EDIT 75 +# define WINSTL_VER_WINSTL_FILESYSTEM_HPP_FILE_FUNCTIONS_EDIT 76 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -153,9 +153,9 @@ std::string contents; winstl::uint64_t numBytes = winstl::load_text_file("mytextfile.ext", contents); \endcode * - * \remarks The character type of the text file is assumed (and controlled) - * to be that of the \c contents parameter. For example, if \c contents is - * of type \c std::wstring then the file will be processed as if it + * \note The character type of the text file is assumed (and controlled) to + * be that of the \c contents parameter. For example, if \c contents is of + * type \c std::wstring then the file will be processed as if it * contains \c wchar_t. * * \note When used with a compiler that does not support partial template @@ -425,13 +425,12 @@ winstl::readlines("mytextfile.ext", lines); \endcode * * - * \remarks The container type's value_type must provide - * a two-parameter constructor whose parameters types are - * char_type const* (where char_type is the - * value_type of the string type S) and - * size_t, indicating the pointer to the beginning and the - * length of the C-style string that represents the line read from the - * file denoted by fileName. + * \note The container type's value_type must provide a + * two-parameter constructor whose parameters types are + * char_type const* (where \c char_type is the \c value_type + * of the string type \c S) and \c size_t, indicating the pointer to the + * beginning and the length of the C-style string that represents the line + * read from the file denoted by \c fileName. * * \note When used with a compiler that does not support partial template * specialisation, the use of string types for which explicit diff --git a/include/winstl/filesystem/filesystem_traits.hpp b/include/winstl/filesystem/filesystem_traits.hpp index fe194b8a..55ad3e40 100644 --- a/include/winstl/filesystem/filesystem_traits.hpp +++ b/include/winstl/filesystem/filesystem_traits.hpp @@ -5,11 +5,11 @@ * Unicode specialisations thereof. * * Created: 15th November 2002 - * Updated: 28th May 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2002-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -56,7 +56,7 @@ # define WINSTL_VER_WINSTL_FILESYSTEM_HPP_FILESYSTEM_TRAITS_MAJOR 4 # define WINSTL_VER_WINSTL_FILESYSTEM_HPP_FILESYSTEM_TRAITS_MINOR 22 # define WINSTL_VER_WINSTL_FILESYSTEM_HPP_FILESYSTEM_TRAITS_REVISION 11 -# define WINSTL_VER_WINSTL_FILESYSTEM_HPP_FILESYSTEM_TRAITS_EDIT 194 +# define WINSTL_VER_WINSTL_FILESYSTEM_HPP_FILESYSTEM_TRAITS_EDIT 195 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -299,7 +299,7 @@ struct filesystem_traits /// \pre nullptr != dir /// /// \note \c dir is assumed to contain space for an additional - /// character (if required) and NUL-terminator + /// character (if required) and NUL character. /// /// \see \link #path_name_separator path_name_separator() \endlink static @@ -1947,7 +1947,7 @@ struct filesystem_traits if (r + 2 < cchBuffer) { - // There's enough space for the result and the closing quote and the nul-terminator + // There's enough space for the result and the closing quote and the NUL character buffer[r + 2] = '\0'; n = r + 2; diff --git a/include/winstl/filesystem/path.hpp b/include/winstl/filesystem/path.hpp index 1921d253..e670876b 100644 --- a/include/winstl/filesystem/path.hpp +++ b/include/winstl/filesystem/path.hpp @@ -4,14 +4,14 @@ * Purpose: Simple class that represents a path. * * Created: 1st May 1993 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Thanks: Pablo Aguilar for reporting defect in push_ext() (which * doesn't work for wide-string builds). * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 1993-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -57,7 +57,7 @@ # define WINSTL_VER_WINSTL_FILESYSTEM_HPP_PATH_MAJOR 7 # define WINSTL_VER_WINSTL_FILESYSTEM_HPP_PATH_MINOR 1 # define WINSTL_VER_WINSTL_FILESYSTEM_HPP_PATH_REVISION 11 -# define WINSTL_VER_WINSTL_FILESYSTEM_HPP_PATH_EDIT 329 +# define WINSTL_VER_WINSTL_FILESYSTEM_HPP_PATH_EDIT 330 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -238,7 +238,7 @@ class basic_path #ifdef STLSOFT_CF_MEMBER_TEMPLATE_CTOR_SUPPORT /// Constructs a path from a string object. /// - /// \remarks The string object may be any type for which the + /// \note The string object may be any type for which the /// c_str_len and c_str_data /// \ref group__concept__Shim__string_access "String Access Shims" are /// defined. The following example shows the use of a window handle @@ -362,9 +362,9 @@ class basic_path class_type& push_ext(char_type const* rhs, bool_type bAddPathNameSeparator = false); /// Ensures that the path has a trailing path name separator /// - /// \remarks If the path currently contains path name separators, and - /// they are all forward slashes '/', then a forward slash will be - /// used; otherwise a backslash '\\' will be used. + /// \note If the path currently contains path name separators, and they + /// are all forward slashes '/', then a forward slash will be used; + // otherwise a backslash '\\' will be used. class_type& push_sep(); /// Pops the last path element from the path /// @@ -464,7 +464,7 @@ class basic_path size_type length() const STLSOFT_NOEXCEPT; /// Returns the length of the converted path /// - /// \remarks Equivalent to length() + /// \note Equivalent to length(). size_type size() const STLSOFT_NOEXCEPT; /// The maximum possible length of a path static size_type max_size() STLSOFT_NOEXCEPT; @@ -521,7 +521,7 @@ class basic_path /// Evaluates whether the two instances hold strings that refer /// to the same file-system entity. /// - /// \remarks See \link winstl::basic_path::equivalent(C const* ) equivalent()\endlink for an example. + /// \note See \link winstl::basic_path::equivalent(C const* ) equivalent()\endlink for an example. /// /// \note The string comparison is case-insensitive. bool_type equivalent(class_type const& rhs) const STLSOFT_NOEXCEPT; diff --git a/include/winstl/filesystem/squeeze_functions.hpp b/include/winstl/filesystem/squeeze_functions.hpp index 8fd99f96..b21cd15b 100644 --- a/include/winstl/filesystem/squeeze_functions.hpp +++ b/include/winstl/filesystem/squeeze_functions.hpp @@ -4,11 +4,11 @@ * Purpose: Path squeeze functions * * Created: 6th June 2006 - * Updated: 15th April 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2006-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -54,7 +54,7 @@ # define WINSTL_VER_WINSTL_FILESYSTEM_HPP_SQUEEZE_FUNCTIONS_MAJOR 2 # define WINSTL_VER_WINSTL_FILESYSTEM_HPP_SQUEEZE_FUNCTIONS_MINOR 0 # define WINSTL_VER_WINSTL_FILESYSTEM_HPP_SQUEEZE_FUNCTIONS_REVISION 6 -# define WINSTL_VER_WINSTL_FILESYSTEM_HPP_SQUEEZE_FUNCTIONS_EDIT 39 +# define WINSTL_VER_WINSTL_FILESYSTEM_HPP_SQUEEZE_FUNCTIONS_EDIT 40 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -299,7 +299,7 @@ STLSOFT_CLOSE_WORKER_NS_(ximpl_winstl_squeeze_functions_) * the number of characters written (if buffer is non-\c nullptr). In both * cases, it includes the one required for the NUL-terminator * - * \remarks The squeeze algorithm is as follows. The path is split into + * \note The squeeze algorithm is as follows. The path is split into * volume+directory and file+ext. If the buffer is too small to fit the * file+ext, then the result will be a squeezed form of file+ext. If the * buffer is too small to fit the volume+...+file+ext, then the result diff --git a/include/winstl/registry/functions.hpp b/include/winstl/registry/functions.hpp index 16b413b1..ed41e13b 100644 --- a/include/winstl/registry/functions.hpp +++ b/include/winstl/registry/functions.hpp @@ -4,11 +4,11 @@ * Purpose: Registry functions. * * Created: 20th November 1995 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 1995-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -54,7 +54,7 @@ # define WINSTL_VER_WINSTL_REGISTRY_HPP_FUNCTIONS_MAJOR 3 # define WINSTL_VER_WINSTL_REGISTRY_HPP_FUNCTIONS_MINOR 1 # define WINSTL_VER_WINSTL_REGISTRY_HPP_FUNCTIONS_REVISION 7 -# define WINSTL_VER_WINSTL_REGISTRY_HPP_FUNCTIONS_EDIT 65 +# define WINSTL_VER_WINSTL_REGISTRY_HPP_FUNCTIONS_EDIT 66 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -158,7 +158,7 @@ reg_get_string_value( * \retval "any other value" The function failed, and the error code * indicates why * - * \remarks If the function fails, the value of value is + * \note If the function fails, the value of value is * unchanged. */ template diff --git a/include/winstl/registry/reg_key.hpp b/include/winstl/registry/reg_key.hpp index 881fc442..c26df4fd 100644 --- a/include/winstl/registry/reg_key.hpp +++ b/include/winstl/registry/reg_key.hpp @@ -5,14 +5,14 @@ * specialisations thereof. * * Created: 19th January 2002 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Thanks: To Sam Fisher for spotting the defect in the set_value_() * overload for REG_MULTI_SZ values (widestring only). * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2002-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -58,7 +58,7 @@ # define WINSTL_VER_WINSTL_REGISTRY_HPP_REG_KEY_MAJOR 3 # define WINSTL_VER_WINSTL_REGISTRY_HPP_REG_KEY_MINOR 10 # define WINSTL_VER_WINSTL_REGISTRY_HPP_REG_KEY_REVISION 16 -# define WINSTL_VER_WINSTL_REGISTRY_HPP_REG_KEY_EDIT 169 +# define WINSTL_VER_WINSTL_REGISTRY_HPP_REG_KEY_EDIT 170 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -1547,7 +1547,7 @@ basic_reg_key::set_value_( ); #endif - // Create a buffer of sufficient size: total length + a nul-terminator for each value + a double nul-terminator + // Create a buffer of sufficient size: total length + a NUL character for each value + a double NUL character STLSOFT_NS_QUAL(auto_buffer) buff(totalLen + numValues * 1 + 2); if (buff.empty()) diff --git a/include/winstl/registry/reg_value.hpp b/include/winstl/registry/reg_value.hpp index c1224822..790c4deb 100644 --- a/include/winstl/registry/reg_value.hpp +++ b/include/winstl/registry/reg_value.hpp @@ -10,7 +10,7 @@ * regretably now implemented as independent classes. * * Created: 19th January 2002 - * Updated: 21st March 2025 + * Updated: 15th October 2026 * * Thanks: To Diego Chanoux for spotting a defect in the value_sz() method. * @@ -23,7 +23,7 @@ * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2002-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -70,7 +70,7 @@ # define WINSTL_VER_WINSTL_REGISTRY_HPP_REG_VALUE_MAJOR 3 # define WINSTL_VER_WINSTL_REGISTRY_HPP_REG_VALUE_MINOR 5 # define WINSTL_VER_WINSTL_REGISTRY_HPP_REG_VALUE_REVISION 14 -# define WINSTL_VER_WINSTL_REGISTRY_HPP_REG_VALUE_EDIT 136 +# define WINSTL_VER_WINSTL_REGISTRY_HPP_REG_VALUE_EDIT 137 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -654,7 +654,7 @@ basic_reg_value::value_sz() const { WINSTL_ASSERT(0 != data_size); - --data_size; // This is required since the size contains space for the nul-terminator + --data_size; // This is required since the size contains space for the NUL character buffer[data_size / sizeof(char_type)] = 0; // The site of a former bug. Thanks to Diego Chanoux for spotting this diff --git a/include/winstl/shell/memory/functions.h b/include/winstl/shell/memory/functions.h index 16c02a2c..0bf7a59d 100644 --- a/include/winstl/shell/memory/functions.h +++ b/include/winstl/shell/memory/functions.h @@ -4,11 +4,11 @@ * Purpose: Shell memory functions. * * Created: 2nd March 1996 - * Updated: 26th December 2024 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 1996-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -54,7 +54,7 @@ # define WINSTL_VER_WINSTL_SHELL_MEMORY_H_FUNCTIONS_MAJOR 6 # define WINSTL_VER_WINSTL_SHELL_MEMORY_H_FUNCTIONS_MINOR 0 # define WINSTL_VER_WINSTL_SHELL_MEMORY_H_FUNCTIONS_REVISION 10 -# define WINSTL_VER_WINSTL_SHELL_MEMORY_H_FUNCTIONS_EDIT 70 +# define WINSTL_VER_WINSTL_SHELL_MEMORY_H_FUNCTIONS_EDIT 71 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -113,7 +113,7 @@ namespace winstl_project * \return Pointer to the allocated memory block, or \c nullptr if the * request failed. * - * \remarks On failure, the function will set the thread error information, + * \note On failure, the function will set the thread error information, * which may be retrieved by the Win32 API function * ::GetLastError() * @@ -158,7 +158,7 @@ winstl__SHMemAlloc(ws_size_t cb) * * \param pv Pointer to the memory block to be deallocated * - * \remarks On failure, the function will set the thread error information, + * \note On failure, the function will set the thread error information, * which may be retrieved by the Win32 API function * ::GetLastError() * @@ -224,7 +224,7 @@ DECLARE_INTERFACE_(IMallocGcc32,IUnknown) * \return Pointer to the allocated memory block, or \c nullptr if the * request failed or cb is 0 and pv is not \c nullptr. * - * \remarks On failure, the function will set the thread error information, + * \note On failure, the function will set the thread error information, * which may be retrieved by the Win32 API function * ::GetLastError() * diff --git a/include/winstl/shims/access/string/time.hpp b/include/winstl/shims/access/string/time.hpp index 10e3c6f8..25334f45 100644 --- a/include/winstl/shims/access/string/time.hpp +++ b/include/winstl/shims/access/string/time.hpp @@ -4,13 +4,13 @@ * Purpose: Helper functions for the Windows time types. * * Created: 2nd December 2004 - * Updated: 20th March 2025 + * Updated: 15th October 2026 * * Thanks: David Wang, for spotting an error in one of the shim functions. * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2004-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -57,7 +57,7 @@ # define WINSTL_VER_WINSTL_SHIMS_ACCESS_STRING_HPP_TIME_MAJOR 2 # define WINSTL_VER_WINSTL_SHIMS_ACCESS_STRING_HPP_TIME_MINOR 3 # define WINSTL_VER_WINSTL_SHIMS_ACCESS_STRING_HPP_TIME_REVISION 18 -# define WINSTL_VER_WINSTL_SHIMS_ACCESS_STRING_HPP_TIME_EDIT 78 +# define WINSTL_VER_WINSTL_SHIMS_ACCESS_STRING_HPP_TIME_EDIT 79 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -270,7 +270,7 @@ stream_insert(S &stm, SYSTEMTIME const& t) // Because it's possible for external action to change the date // and/or time pictures between the call to calc_sizes and the // two preceeding calls, we guard against an unterminated - // C-style string by forcibly appending the nul-terminator that + // C-style string by forcibly appending the NUL character that // GetTimeFormat() will do for us normally. s.data()[cchTotal] = '\0'; } @@ -345,7 +345,7 @@ c_str_ptr_a( // Because it's possible for external action to change the date // and/or time pictures between the call to calc_sizes and the // two preceeding calls, we guard against an unterminated - // C-style string by forcibly appending the nul-terminator that + // C-style string by forcibly appending the NUL character that // GetTimeFormat() will do for us normally. s.data()[cchTotal] = '\0'; } @@ -395,7 +395,7 @@ c_str_ptr_w( // Because it's possible for external action to change the date // and/or time pictures between the call to calc_sizes and the // two preceeding calls, we guard against an unterminated - // C-style string by forcibly appending the nul-terminator that + // C-style string by forcibly appending the NUL character that // GetTimeFormat() will do for us normally. s.data()[cchTotal] = '\0'; } diff --git a/include/winstl/system/system_information_functions.h b/include/winstl/system/system_information_functions.h index 3b9f19b9..d8dd75f8 100644 --- a/include/winstl/system/system_information_functions.h +++ b/include/winstl/system/system_information_functions.h @@ -4,11 +4,11 @@ * Purpose: System information functions. * * Created: 5th November 2014 - * Updated: 11th March 2024 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * - * Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems + * Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems * Copyright (c) 2014-2019, Matthew Wilson and Synesis Software * All rights reserved. * @@ -54,7 +54,7 @@ # define WINSTL_VER_WINSTL_SYSTEM_H_SYSTEM_INFORMATION_FUNCTIONS_MAJOR 1 # define WINSTL_VER_WINSTL_SYSTEM_H_SYSTEM_INFORMATION_FUNCTIONS_MINOR 1 # define WINSTL_VER_WINSTL_SYSTEM_H_SYSTEM_INFORMATION_FUNCTIONS_REVISION 4 -# define WINSTL_VER_WINSTL_SYSTEM_H_SYSTEM_INFORMATION_FUNCTIONS_EDIT 13 +# define WINSTL_VER_WINSTL_SYSTEM_H_SYSTEM_INFORMATION_FUNCTIONS_EDIT 14 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ @@ -148,9 +148,9 @@ winstl_C_system_information_functions_MORE_DATA_( * written * \param cchBuffer Number of character spaces available in \c buffer * - * \return The number of characters excluding the nul-terminator written if + * \return The number of characters excluding the NUL character written if * cchBuffer is sufficient; the number of characters including the - * nul-terminator if cchBuffer is insufficient. + * NUL character if cchBuffer is insufficient. * * \note There is a defect in GetComputerNameA(), in that the required size * is not returned when the buffer is insufficient. This is handled by @@ -258,9 +258,9 @@ winstl_C_get_computer_name_w( * written * \param cchBuffer Number of character spaces available in \c buffer * - * \return The number of characters excluding the nul-terminator written if + * \return The number of characters excluding the NUL character written if * cchBuffer is sufficient; the number of characters including the - * nul-terminator if cchBuffer is insufficient. + * NUL character if cchBuffer is insufficient. * * \note GetUserNameA() has the unpleasant semantics that it returns double * the required number of characters when \c buffer is insufficient. This diff --git a/include/winstl/winstl.h b/include/winstl/winstl.h index 592659ec..190b91e4 100644 --- a/include/winstl/winstl.h +++ b/include/winstl/winstl.h @@ -5,7 +5,7 @@ * platform discriminations, and definitions of types. * * Created: 15th January 2002 - * Updated: 8th October 2026 + * Updated: 15th October 2026 * * Home: http://stlsoft.org/ * @@ -51,7 +51,7 @@ # define WINSTL_VER_WINSTL_H_WINSTL_MAJOR 3 # define WINSTL_VER_WINSTL_H_WINSTL_MINOR 18 # define WINSTL_VER_WINSTL_H_WINSTL_REVISION 15 -# define WINSTL_VER_WINSTL_H_WINSTL_EDIT 245 +# define WINSTL_VER_WINSTL_H_WINSTL_EDIT 246 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ /** \file winstl/winstl.h @@ -631,7 +631,7 @@ x86-64 * * \param expr Must be non-zero, or an assertion will be fired * - * \remarks By default this is defined to \ref STLSOFT_ASSERT. However, this + * \note By default this is defined to \ref STLSOFT_ASSERT. However, this * can be overriden if a prior definition is encountered, allowing the * runtime assertion of WinSTL components to use a different mechanism to * those in the other \ref group__projects "projects". @@ -653,7 +653,7 @@ x86-64 * * \param expr A compile-time evaluatable condition that must be non-zero, or compilation will fail. * - * \remarks This is defined to \ref STLSOFT_STATIC_ASSERT. + * \note This is defined to \ref STLSOFT_STATIC_ASSERT. */ #define WINSTL_STATIC_ASSERT(expr) STLSOFT_STATIC_ASSERT(expr) @@ -841,7 +841,7 @@ int main() } \endcode * - * \remarks These macros are used throughout the implementation of the + * \note These macros are used throughout the implementation of the * STLSoft libraries. However, we do not recommend their use in application * code for the simple reason that they are ugly and do not represent a * widely recognised idiom. Of course, if they suit your purposes, then by