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,92 @@
.TH "src/include/serif/utils/dependencies/dependency_context.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/utils/dependencies/dependency_context.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <concepts>\fP
.br
\fR#include <tuple>\fP
.br
\fR#include <type_traits>\fP
.br
\fR#include <utility>\fP
.br
\fR#include 'serif/utils/dependencies/resource\&.hpp'\fP
.br
\fR#include 'serif/utils/dependencies/detail/type_lists\&.hpp'\fP
.br
\fR#include 'serif/utils/misc/concepts/concat\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBserif::utils::dependencies::DependencyContext< ResourceTs >\fP"
.br
.ti -1c
.RI "class \fBserif::utils::dependencies::DependencyContextView< ParentT, KeyList< KeyTs\&.\&.\&. > >\fP"
.br
.in -1c
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::utils\fP"
.br
.ti -1c
.RI "namespace \fBserif::utils::dependencies\fP"
.br
.ti -1c
.RI "namespace \fBserif::utils::dependencies::detail\fP"
.br
.in -1c
.SS "Concepts"
.in +1c
.ti -1c
.RI "concept \fBserif::utils::dependencies::IsDependencyContext\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename\&.\&.\&. Resources>
.br
requires (IsResource<Resources> && \&.\&.\&.) && \fBmisc::traits::all_unique_types_v\fP<typename std::remove_cvref_t<Resources>::Key\&.\&.\&.>auto \fBserif::utils::dependencies::make_dependency_context\fP (Resources &&\&.\&.\&. resources)"
.br
.RI "Build a context whose schema follows directly from its resource keys and types\&. "
.ti -1c
.RI "template<typename\&.\&.\&. Resources> consteval bool \fBserif::utils::dependencies::detail::combinable_resources\fP (\fBtypes::TypeList\fP< Resources\&.\&.\&. >)"
.br
.RI "Combining contexts must preserve every resource, with exactly one owner of each key\&. "
.ti -1c
.RI "template<IsDependencyContext\&.\&.\&. Contexts>
.br
requires (\fBdetail::combinable_resources\fP(\fBmisc::concepts::ConcatT\fP<typename Contexts::Resources\&.\&.\&.>{}))auto \fBserif::utils::dependencies::combine_dependency_contexts\fP (const Contexts &\&.\&.\&. contexts)"
.br
.RI "Copy disjoint resources and their tracking policies into one context; borrowed objects retain their original lifetime\&. "
.in -1c
.SS "Variables"
.in +1c
.ti -1c
.RI "template<typename T> constexpr bool \fBserif::utils::dependencies::is_dependency_context_v\fP = false"
.br
.ti -1c
.RI "template<typename\&.\&.\&. Resources> constexpr bool \fBserif::utils::dependencies::is_dependency_context_v< DependencyContext< Resources\&.\&.\&. > >\fP = true"
.br
.ti -1c
.RI "template<typename ParentT, typename KeysT> constexpr bool \fBserif::utils::dependencies::is_dependency_context_v< DependencyContextView< ParentT, KeysT > >\fP = true"
.br
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.