docs(docs): built docs

Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
This commit is contained in:
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions

View File

@@ -0,0 +1,51 @@
\doxysection{src/include/serif/utils/dependencies/key\+\_\+list\+\_\+operations.hpp File Reference}
\hypertarget{key__list__operations_8hpp}{}\label{key__list__operations_8hpp}\index{src/include/serif/utils/dependencies/key\_list\_operations.hpp@{src/include/serif/utils/dependencies/key\_list\_operations.hpp}}
{\ttfamily \#include $<$cstddef$>$}\newline
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
{\ttfamily \#include "{}serif/utils/dependencies/detail/type\+\_\+lists.\+hpp"{}}\newline
Include dependency graph for key\+\_\+list\+\_\+operations.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{key__list__operations_8hpp__incl}
\end{center}
\end{figure}
This graph shows which files directly or indirectly include this file\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{key__list__operations_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1utils}{serif\+::utils}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies}{serif\+::utils\+::dependencies}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Concepts}
\begin{DoxyCompactItemize}
\item
concept \mbox{\hyperlink{conceptserif_1_1utils_1_1dependencies_1_1_contains_key}{serif\+::utils\+::dependencies\+::\+Contains\+Key}}
\begin{DoxyCompactList}\small\item\em Test exact key membership, rejecting malformed and duplicate-\/key lists. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Typedefs}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$Is\+Key\+List... Lists$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_a4b225a37465f007a877f89860d3627c1}{serif\+::utils\+::dependencies\+::\+Combined\+Key\+List}} = \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1detail_1_1_merge_key_lists}{detail\+::\+Merge\+Key\+Lists}}$<$\mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{Key\+List}}$<$$>$, std\+::remove\+\_\+cvref\+\_\+t$<$Lists$>$...$>$\+::type
\begin{DoxyCompactList}\small\item\em Combine requirements in first-\/appearance order, retaining distinct keys with shared targets. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename KeyT, typename KeysT$>$ \newline
requires Contains\+Key$<$KeyT, KeysT$>$}\\consteval std\+::size\+\_\+t \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_a2b6e1389a71419222053720f4bd9cd43}{serif\+::utils\+::dependencies\+::key\+\_\+index}} ()
\begin{DoxyCompactList}\small\item\em Locate a declared key in its ordered list; absent keys are rejected at compile time. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Variables}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$Is\+Key\+List KeysT$>$ }\\constexpr std\+::size\+\_\+t \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_a317a69acc139be6b2d45f95cf1c1412c}{serif\+::utils\+::dependencies\+::key\+\_\+count\+\_\+v}} = \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1detail_1_1_key_list_size}{detail\+::\+Key\+List\+Size}}$<$std\+::remove\+\_\+cvref\+\_\+t$<$KeysT$>$$>$\+::value
\begin{DoxyCompactList}\small\item\em Count distinct declared keys without constructing their associated values. \end{DoxyCompactList}\end{DoxyCompactItemize}