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,52 @@
\doxysection{src/include/serif/dimensions/runtime/concepts.hpp File Reference}
\hypertarget{dimensions_2runtime_2concepts_8hpp}{}\label{dimensions_2runtime_2concepts_8hpp}\index{src/include/serif/dimensions/runtime/concepts.hpp@{src/include/serif/dimensions/runtime/concepts.hpp}}
Runtime concept for a type that can be projected to a runtime type. This is useful when converting from the compile time type system to something that can be inspected at runtime.
{\ttfamily \#include $<$string\+\_\+view$>$}\newline
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
{\ttfamily \#include "{}serif/dimensions/quantities.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/dimensions/runtime/runtime.\+hpp"{}}\newline
Include dependency graph for concepts.\+hpp\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{dimensions_2runtime_2concepts_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]{dimensions_2runtime_2concepts_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1dimensions}{serif\+::dimensions}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1dimensions_1_1runtime}{serif\+::dimensions\+::runtime}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Concepts}
\begin{DoxyCompactItemize}
\item
concept \mbox{\hyperlink{conceptserif_1_1dimensions_1_1runtime_1_1_runtime_identified_thermodynamic_quantity}{serif\+::dimensions\+::runtime\+::\+Runtime\+Identified\+Thermodynamic\+Quantity}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Variables}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$Runtime\+Identified\+Thermodynamic\+Quantity Quantity$>$ }\\constexpr \mbox{\hyperlink{classserif_1_1dimensions_1_1runtime_1_1_thermodynamic_quantity_i_d}{Thermodynamic\+Quantity\+ID}} \mbox{\hyperlink{namespaceserif_1_1dimensions_1_1runtime_ad1eac97b6b9f34f3be395e42d7edc4ba}{serif\+::dimensions\+::runtime\+::thermodynamic\+Quantity\+ID}} \{std\+::string\+\_\+view\{Quantity\+::identifier\}\}
\begin{DoxyCompactList}\small\item\em Extract a compile time identifier from a thermodynamic quantity and project it into a runtime string\+\_\+view. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
Runtime concept for a type that can be projected to a runtime type. This is useful when converting from the compile time type system to something that can be inspected at runtime.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}