2 Commits

Author	SHA1	Message	Date
rleigh-electradx	c8bc1bd896	Correct the documented make_xxx factory signatures and examples (#1530) ... * Corrected the documented make_xxx factory signatures and examples The Make template sections across the container documentation had drifted from the implementations, largely through copy-paste: - map.md, multimap.md and flat-multimap.md all documented make_flat_map; multiset.md documented make_set; flat-multiset.md documented make_flat_set; unordered-multimap.md documented make_unordered_map. Names and examples now match each container. - Every signature omitted the C++11-required trailing return type despite the sections being labelled C++11 and above; several also used a parameter name (TValues) that did not match any template parameter, and the unordered map headers were missing a comma. - forward-list.md documented a make_array-style signature with an explicit element type; the real function deduces the element type as the common type of the arguments, as documented for make_list. - The flat_set/flat_multiset template headers were missing the variadic parameter pack, and their examples passed a braced list to a variadic function, which does not compile; set.md used TKeyCompare where the implementation uses TCompare. - deque.md and the reference container docs were missing code fences. - Updated the four reference_flat_* function. However these functions cannot be instantiated at all (the reference containers have no initializer_list constructor, since one would dangle by design), so the documented examples have never compiled. Every remaining documented example verified to compile with clang 22 (C++17) against the current headers. * Fixed C++17-only syntax in factory examples and flagged the non-compilable ones Review feedback on the make_xxx documentation examples: - All the map-family factory examples are labelled C++11 and above but constructed their pairs with class template argument deduction (etl::pair{0, 1}), which requires C++17. The pairs in the make_flat_map, make_flat_multimap, make_map, make_multimap, make_unordered_map, make_unordered_multimap, make_reference_flat_map and make_reference_flat_multimap examples now name their template arguments explicitly. The template deduction guide examples are unchanged, as those sections are labelled C++17 and above. Verified with clang 22 in C++14 mode, which, like C++11, has no deduction guides. - The four make_reference_flat_* examples are now preceded by a warning callout stating that they do not currently compile: the functions cannot be instantiated because the reference containers have no initializer_list constructor. The examples themselves are retained, rewritten to pass named lvalues rather than temporaries, since the reference containers store references to external objects and the temporaries would dangle even if the functions compiled. The defect is being reported separately. --------- Co-authored-by: John Wellbelove <jwellbelove@users.noreply.github.com>	2026-08-04 11:45:49 +01:00
John Wellbelove	4a88884b39	Issue/add hugo support for documentation (#1449) ... * Add ranges * Initial Hugo setup * Work in progress * Added selection for local or remote site * Updated to 'light' theme * Changed to using Hextra Hugo theme * Changed to using Hextra Hugo theme * Changed to Hextra Hugo theme * Change to Hextra Hugo theme * Updated Hugo setup. * Updated Hugo setup. # Conflicts: # docs/releases/_index.md * Work in progress * Added new fonts Added new documentation * Latest documentation updates * Latest documentation updates # Conflicts: # docs/containers/array.md # docs/containers/array_view.md # docs/containers/array_wrapper.md # docs/containers/bip_buffer_spsc_atomic.md # docs/containers/bitset.md # docs/containers/indirect_vector.md # docs/containers/vector.md # docs/getting-started/compilers.md * Added bloom_filter markdown doc * Added more documentation Updated CSS for light and dark modes * Fixed some menus Added mode documentation files * Updated CSS rules Added badges to home page Added uniqur_ptr + pool tutorial * Fixed formatting on the home page markdown Modified light amd dark code formatting * Updated unique_ptr-with-pool * Added container and shared message tutorials * Updates to documentation * Added const_multimap * Updated source-formatting.md * Added initial raw text files form Web site editor * Innore coverage build directory * Exported raw text documentation files from the web site editor * Hugo updates * Added Hugo intalation and markdown descriptions * More addition to the documentation * Added closure.md and updates to delegate.md * Added format.md * Added documentation for etl::delegate_observable, etl::function, Base64 codec * Added io_port documentation * Added basic_format_spec * Added documentation for string_stream and string utilities. * Added more documentation Updated the documentation CSS * Added documentation for clocks, day, duration * Added more documentation for chrono classes Updated callouts * More chrono documentation * Completed chrono documentation * Maths functions documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Added multiple documentation files * Added iterator.md * Added debug_count.md and versions.md * Added debug_count.md and versions.md * Added more documentation * More documentation * Added some design pattern documentation Modified some of the layout files Modified the About documentation * Converted more documentation pages Modified the site CSS * Added more documentation Moced some documentation files to new directories * Added more documentation Tweaks to CSS * Added callback_timer_deferred_locked documentation * Added callback_timer_locked documentation * More documentation updates * More documentation updates * More documentation updates * New documentation files. Harmonised file name format * New documentation files. * Multiple document updates * Multiple document updates * Final conversion of web pages * Updates before PR * Updates before PR * Updates before PR # Conflicts: # docs/blog/_index.md * Final pre PR updates * Updates to message framework documentation * Renamed directory * Fix spelling * Added author and date to blog files Moved documentation files merged from development * Fixed 'Description' typo * Fix typos # Conflicts: # docs/IO/io_port.md # docs/containers/sets/const-multiset.md # docs/containers/sets/const-set.md # docs/maths/correlation.md # docs/maths/gamma.md * Renamed two files to lower case * Minor renaming * Added author and date * Updated callout on bresenham_line.md Added support for showing the ETL version on the documentation first page, by copying the version.txt file as a hugo asset. Updated the Python 'update_release.py' to copy 'version.txt' * Replace space in filename with hyphen. Added more information to hugo-commands.md * Replace space in filename with hyphen. Added more information to hugo-commands.md # Conflicts: # docs/getting-started/view-the-docs-locally/hugo-commands.md * Added a link to pseudo_moving_average.md * Updated title pages for groups * Fixed missing 404 for non-existent pages * Fixed coordinate variable names in the 'Calculating the intersection' example --------- Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.co.uk>	2026-06-06 13:12:44 +01:00