libdpf/doc/libdpf.md
2026-09-26 23:51:06 -06:00

142 lines
1.6 KiB
Markdown

\mainpage notitle
<a id="mainpage"/>
%LIBDPF_INCLUDE_GETTING_STARTED_INTRODUCTION%
<!-- PAGE SEPARATOR -->
\page basics First program
%LIBDPF_INCLUDE_GETTING_DPF_BASICS%
<!-- PAGE SEPARATOR -->
\page getting_started Manual
The domain, the payload, and the walk.
Shorter domains make shorter keys.
- [Domains](@ref input_types) — the secret index
- [Payloads](@ref output_types) — the group at that index
- [Evaluation](@ref evaluation) — point, interval, full domain, sequence
- [Iterables](@ref iterables) — walk the shares a multi-point eval wrote
Samples for each of those are under [Code examples](@ref listings).
<!-- PAGE SEPARATOR -->
\page input_types Domains
%LIBDPF_INCLUDE_GETTING_STARTED_INPUT_TYPES%
<!-- PAGE SEPARATOR -->
\page output_types Payloads
%LIBDPF_INCLUDE_GETTING_STARTED_OUTPUT_TYPES%
<!-- PAGE SEPARATOR -->
\page evaluation Evaluation
%LIBDPF_INCLUDE_GETTING_STARTED_EVALUATION%
<!-- PAGE SEPARATOR -->
\page iterables Iterables
%LIBDPF_INCLUDE_GETTING_STARTED_ITERABLES%
<!-- PAGE SEPARATOR -->
\page bugs Bugs
%LIBDPF_INCLUDE_MISC_BUGS%
<!-- PAGE SEPARATOR -->
\page changes Changelog
%LIBDPF_INCLUDE_MISC_CHANGES%
<!-- PAGE SEPARATOR -->
\page todo TODO
%LIBDPF_INCLUDE_MISC_TODO%
<!-- PAGE SEPARATOR -->
\page submodules Submodules
%LIBDPF_INCLUDE_MISC_SUBMODULES%
<!-- PAGE SEPARATOR -->
\page authors Authors
%LIBDPF_INCLUDE_MISC_AUTHORS%
<!-- PAGE SEPARATOR -->
\page license License
%LIBDPF_INCLUDE_MISC_LICENSE%
<!-- PAGE SEPARATOR -->
\page listings Code examples
%LIBDPF_INCLUDE_CODE_LISTINGS%