Update Doxyfile for new copacabana

Author: jfalcou

doc/Doxyfile

@@ -1382,38 +1382,14 @@ HTML_FOOTER            = $(DOXYGEN_ASSETS)/footer.html
 
 HTML_STYLESHEET        =
 
-# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
-# cascading style sheets that are included after the standard style sheets
-# created by doxygen. Using this option one can overrule certain style aspects.
-# This is preferred over using HTML_STYLESHEET since it does not replace the
-# standard style sheet and is therefore more robust against future updates.
-# Doxygen will copy the style sheet files to the output directory.
-# Note: The order of the extra style sheet files is of importance (e.g. the last
-# style sheet in the list overrules the setting of the previous ones in the
-# list).
-# Note: Since the styling of scrollbars can currently not be overruled in
-# Webkit/Chromium, the styling will be left out of the default doxygen.css if
-# one or more extra stylesheets have been specified. So if scrollbar
-# customization is desired it has to be added explicitly. For an example see the
-# documentation.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_EXTRA_STYLESHEET  = $(DOXYGEN_ASSETS)/custom.css \
-                         color.css \
-                         $(DOXYGEN_ASSETS)/doxygen-awesome.css \
-                         $(DOXYGEN_ASSETS)/doxygen-awesome-sidebar-only.css
-
-# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
-# other source files which should be copied to the HTML output directory. Note
-# that these files will be copied to the base HTML output directory. Use the
-# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
-# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
-# files will be copied as-is; there are no commands or markers available.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_EXTRA_FILES       = $(DOXYGEN_ASSETS)/godbolt.js \
-                         $(DOXYGEN_ASSETS)/fragment.js \
-                         $(DOXYGEN_ASSETS)/paragraph.js
+HTML_EXTRA_STYLESHEET  = $(AWESOME_ASSETS)/doxygen-awesome.css
+HTML_EXTRA_STYLESHEET += $(AWESOME_ASSETS)/doxygen-awesome-sidebar-only.css
+HTML_EXTRA_STYLESHEET += $(DOXYGEN_ASSETS)/custom.css
+HTML_EXTRA_STYLESHEET += color.css
+HTML_EXTRA_FILES       = $(DOXYGEN_ASSETS)/godbolt.js
+HTML_EXTRA_FILES      += $(AWESOME_ASSETS)/doxygen-awesome-fragment-copy-button.js
+HTML_EXTRA_FILES      += $(AWESOME_ASSETS)/doxygen-awesome-paragraph-link.js
+HTML_EXTRA_FILES      += $(AWESOME_ASSETS)/doxygen-awesome-tabs.js
 
 # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
 # should be rendered with a dark or light theme.
@@ -1718,6 +1694,7 @@ ECLIPSE_DOC_ID         = org.doxygen.Project
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
 DISABLE_INDEX          = YES
+PAGE_OUTLINE_PANEL      = NO
 
 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
 # structure should be generated to display hierarchical information. If the tag

doc/base.html

@@ -17,10 +17,12 @@
 <script type="text/javascript" src="$relpath^jquery.js"></script>
 <script type="text/javascript" src="$relpath^dynsections.js"></script>
 <script type="text/javascript" src="$relpath^godbolt.js"></script>
-<script type="text/javascript" src="$relpath^fragment.js"></script>
-<script type="text/javascript" src="$relpath^paragraph.js"></script>
+<script type="text/javascript" src="$relpath^doxygen-awesome-fragment-copy-button.js"></script>
+<script type="text/javascript" src="$relpath^doxygen-awesome-paragraph-link.js"></script>
+<script type="text/javascript" src="$relpath^doxygen-awesome-tabs.js"></script>
 <script type="text/javascript">
   DoxygenAwesomeParagraphLink.init()
+  DoxygenAwesomeTabs.init()
   DoxygenAwesomeFragmentCopyButton.init()
   SendToGodbolt.init("spy","clang1600","-O3 -std=c++20 -DNEDBUG")
 </script>

doc/index.hpp

@@ -0,0 +1,59 @@
+\mainpage The C++ Information Broker
+
+Detection and versioning of operating systems, compilers, architecture, and other elements are traditionally done using preprocessor macros. Libraries like [Boost.Predef](https://www.boost.org/doc/libs/release/doc/html/predef.html) provide a sanitized interface on top of those but still exist in a world where the preprocessor is king.
+
+SPY is a C++20 (and onward) library that gathers similar information and provides a `constexpr` compatible interface to access this information, making its exploitation within `constexpr` contexts possible.
+
+# Some References
+
+* [Our CppCon 2019 Lightning talk slides](https://docs.google.com/presentation/d/1nSBhU4pr5EWznni0MYsyDkMCr3O3q2XS-KQdz2_BRRI/edit?usp=sharing)
+* [Our CppCon 2019 Lightning talk](https://www.youtube.com/watch?v=t406o2EhG-A)
+
+@htmlonly
+<center>
+<iframe width="560" height="315" src="https://www.youtube.com/embed/t406o2EhG-A&amp;controls=0" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen>
+</iframe>
+</center>
+@endhtmlonly
+
+# A Short Example
+
+```cpp
+#include <iostream>
+#include <spy/spy.hpp>
+
+int main()
+{
+  std::cout << "OS                : " << spy::operating_system     << std::endl;
+  std::cout << "CPU Architecture  : " << spy::architecture         << std::endl;
+  std::cout << "SIMD Instructions : " << spy::simd_instruction_set << std::endl;
+  std::cout << "Compiler          : " << spy::compiler             << std::endl;
+  std::cout << "libc version      : " << spy::libc                 << std::endl;
+  std::cout << "libstd            : " << spy::stdlib               << std::endl;
+}
+```
+
+# Licence
+
+This library is licensed under the [Boost Software License](https://opensource.org/licenses/BSL-1.0):
+
+```
+Copyright : SPY Project Contributors
+
+Permission is hereby granted, free of charge, to any person or organization obtaining a copy of the
+software and accompanying documentation covered by this license (the "Software") to use, reproduce,
+display, distribute, execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to do so, all subject to the
+following:
+
+The copyright notices in the Software and this entire statement, including the above license grant,
+this restriction and the following disclaimer, must be included in all copies of the Software, in
+whole or in part, and all derivative works of the Software, unless such copies or derivative works
+are solely in the form of machine-executable object code generated by a source language processor.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
+NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE
+BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```

doc/index.md

@@ -164,6 +164,7 @@ namespace spy::_
 
 namespace spy
 {
+  // clang-format off
 //================================================================================================
 //! @ingroup api
 //! @brief SIMD extensions set  reporting value
@@ -173,16 +174,16 @@ namespace spy
 //! exactly, below or above a given reference instruction set. Detectable instructions sets depends
 //! on SIMD hardware vendor
 //!
-//! | Architecture      | Supported SIMD instructions sets | | ----------------- |
-//! --------------------------------------------------------------------------------------- | |
-//! **X86 SSE**       | `spy::sse1_`, `spy::sse2_`, `spy::sse3_`, `spy::ssse3_`, `spy::sse41_`,
-//! `spy::sse42_`   | | **X86 AVX**       | `spy::avx_`, `spy::avx2_`, `spy::avx512_` | | **Power PC
-//! VMX**  | `spy::vmx_`, `spy::vmx_2_03_`, `spy::vmx_2_05_`, `spy::vmx_2_06_`, `spy::vmx_2_07_`,
-//! `spy::vmx_3_00_`, `spy::vmx_3_01_` | | **Power PC VSX**  | `spy::vsx_`, `spy::vsx_2_06_`,
-//! `spy::vsx_2_07_`, `spy::vsx_3_00_`, `spy::vsx_3_01_`     | | **ARM NEON**      | `spy::neon_`,
-//! `spy::asimd_` | | **ARM SVE**       | `spy::sve_`,`spy::sve128_`, `spy::sve256_`,
-//! `spy::sve512_`, `spy::sve1024_`             | | **WASM**          | `spy::simd128_` | |
-//! **RISC-V**        | `spy::rvv_`` |
+//! | Architecture      | Supported SIMD instructions sets |
+//! | ----------------- | --------------------------------------------------------------------------------------- |
+//! | **X86 SSE** | `spy::sse1_`, `spy::sse2_`, `spy::sse3_`, `spy::ssse3_`, `spy::sse41_`, `spy::sse42_`   |
+//! | **X86 AVX** | `spy::avx_`, `spy::avx2_`, `spy::avx512_` |
+//! | **Power PC VMX** | `spy::vmx_`, `spy::vmx_2_03_`, `spy::vmx_2_05_`, `spy::vmx_2_06_`, `spy::vmx_2_07_`, `spy::vmx_3_00_`, `spy::vmx_3_01_` |
+//! | **Power PC VSX** | `spy::vsx_`, `spy::vsx_2_06_`, `spy::vsx_2_07_`, `spy::vsx_3_00_`, `spy::vsx_3_01_`     |
+//! | **ARM NEON** | `spy::neon_`, `spy::asimd_` |
+//! | **ARM SVE** | `spy::sve_`, `spy::sve128_`, `spy::sve256_`, `spy::sve512_`, `spy::sve1024_`             |
+//! | **WASM** | `spy::simd128_` |
+//! | **RISC-V** | `spy::rvv_` |
 //!
 //! Complete set of comparison operators is provided for those sets. Order of instructions sets
 //! are built so that if an instructions set supersedes another, it is considered greater than. For
@@ -201,11 +202,11 @@ namespace spy
 //!
 //! | Architecture  | Generic indicator   |
 //! | ------------- | --------------------|
-//! | **X86**       | `spy::x86_simd_`    |
-//! | **Power PC**  | `spy::ppc_simd_`    |
-//! | **ARM**       | `spy::arm_simd_`    |
-//! | **WASM**      | `spy::wasm_simd_`   |
-//! | **RISC-V**    | `spy::riscv_simd_`  |
+//! | **X86** | `spy::x86_simd_`    |
+//! | **Power PC** | `spy::ppc_simd_`    |
+//! | **ARM** | `spy::arm_simd_`    |
+//! | **WASM** | `spy::wasm_simd_`   |
+//! | **RISC-V** | `spy::riscv_simd_`  |
 //!
 //! @subgroupheader{Example - SIMD Architectures}
 //! @godbolt{samples/simd-arch.cpp}
@@ -215,19 +216,20 @@ namespace spy
 //! Some SIMD instructions set provides supplemental instructions on top of existing system.
 //! Those supplemental instruction set can be checked using the `spy::supports` namespace.
 //!
-//! | Architecture  | Supported SIMD instructions sets | | ------------- |
-//! ------------------------------------------------------------------------------------| | X86 AVX
-//! | `xop_`, `fma_`, `fma4_`                                                             | | X86
-//! AVX512    | `bw_`, `cd_`, `dq_`, `er_`, `ifma_`, `pf_`, `vl_`, `popcntdq_` | |               |
-//! `_4fmaps_`, `vnniw_`, `vbmi_`, `bf16_`,`bitalg_`, `vbmi2_`, `vnni_`, `vpintersect_` |
+//! | Architecture  | Supported SIMD instructions sets |
+//! | ------------- | ------------------------------------------------------------------------------------------------|
+//! | **X86 AVX**   | `xop_`, `fma_`, `fma4_`                                                                         |
+//! | **X86 AVX512**| `bw_`, `cd_`, `dq_`, `er_`, `ifma_`, `pf_`, `vl_`, `popcntdq_`, `_4fmaps_`, `vnniw_`, `vbmi_`   |
+//! |               | `bf16_`, `bitalg_`, `vbmi2_`, `vnni_`, `vpintersect_`                                           |
 //!
 //! @subgroupheader{Example - SIMD Architectures}
 //! @godbolt{samples/simd-additional.cpp}
 //!
 //================================================================================================
+// clang-format off
 #if defined(SPY_SIMD_DETECTED)
   constexpr inline auto simd_instruction_set = _::simd_info<SPY_SIMD_VENDOR, SPY_SIMD_DETECTED> {};
-#else
+  #else
   constexpr inline auto simd_instruction_set = _::simd_info<> {};
 #endif