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/snapshot.hpp File Reference}
\hypertarget{snapshot_8hpp}{}\label{snapshot_8hpp}\index{src/include/serif/utils/dependencies/snapshot.hpp@{src/include/serif/utils/dependencies/snapshot.hpp}}
{\ttfamily \#include $<$concepts$>$}\newline
{\ttfamily \#include $<$functional$>$}\newline
{\ttfamily \#include $<$memory$>$}\newline
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
{\ttfamily \#include $<$utility$>$}\newline
Include dependency graph for snapshot.\+hpp\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{snapshot_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]{snapshot_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_value_snapshot}{serif\+::utils\+::dependencies\+::\+Value\+Snapshot}}
\begin{DoxyCompactList}\small\item\em Default tracking owns an exact value copy; noncopyable resources supply another policy. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classserif_1_1utils_1_1dependencies_1_1_projected_snapshot}{serif\+::utils\+::dependencies\+::\+Projected\+Snapshot$<$ Function\+T $>$}}
\end{DoxyCompactItemize}
\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_snapshot_policy_for}{serif\+::utils\+::dependencies\+::\+Snapshot\+Policy\+For}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename FunctionT$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_abd3aa4196f4454ea6052835065181c5f}{serif\+::utils\+::dependencies\+::track\+\_\+by}} (FunctionT \&\&function)
\begin{DoxyCompactList}\small\item\em Select the state that determines whether a source needs recomputation. \end{DoxyCompactList}\item
{\footnotesize template$<$typename PolicyT, typename ValueT$>$ \newline
requires Snapshot\+Policy\+For$<$PolicyT, ValueT$>$}\\const void \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_ae72aa784367f082484e9e998653de2d0}{serif\+::utils\+::dependencies\+::source\+\_\+identity}} (const PolicyT \&policy, const ValueT \&value)
\begin{DoxyCompactList}\small\item\em Views may identify their underlying resource; ordinary sources retain object identity. \end{DoxyCompactList}\end{DoxyCompactItemize}