ryan/libdpf
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Publish a scannable manual and a bibliography that links each paper back to the pages that use it.

Browse source 
Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
Ryan Henry 2026-09-26 23:51:06 -06:00
parent cf8054a0b3
commit 695f8e84f7
45 changed files with 4848 additions and 338 deletions
Download patch file Download diff file Expand all files Collapse all files

78
doc/Doxyfile
View file

@ -291,7 +291,10 @@ TAB_SIZE = 4
# @} or use a double escape (\\{ and \\})
ALIASES = "license=@par License:^^" \
"complexity=@par Complexity:^^"
"complexity=@par Complexity:^^" \
"rounds=@par Rounds:^^" \
"communication=@par Communication:^^" \
"preprocessing=@par Preprocessing:^^"
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
@ -383,7 +386,7 @@ MARKDOWN_STRICT = YES
# Minimum value: 0, maximum value: 99, default value: 6.
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
TOC_INCLUDE_HEADINGS = 5
TOC_INCLUDE_HEADINGS = 1
# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
# generate identifiers for the Markdown headings. Note: Every identifier is
@ -1011,15 +1014,30 @@ INPUT = include/dpf.hpp \
include/grotto.hpp \
include/grotto/ \
doc/libdpf_full.md \
doc/pages/ppvc.md \
doc/examples.dox \
doc/namespaces.dox \
doc/directories.dox \
doc/assets/assets.dox \
doc/ideal_functionalities.dox \
doc/pages/guided_tour.md \
doc/pages/capabilities.md \
doc/pages/verifiability.md \
doc/pages/programmability.md \
doc/pages/multiparty.md \
doc/pages/which_dpf.md \
doc/pages/comparisons.md \
doc/pages/multipoint.md \
doc/pages/dealer_free.md \
doc/pages/beaver.md \
doc/pages/api.md \
doc/pages/bibliography.md \
doc/pages/jet_and_ring.md \
doc/pages/repr_and_twist.md \
doc/pages/applications.md \
doc/pages/ppvc.md \
thirdparty/thirdparty.dox \
examples \
doc \
test
doc
# This tag can be used to specify the character encoding of the source files
# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses
@ -1076,7 +1094,8 @@ RECURSIVE = YES
# run.
EXCLUDE = *.md \
*.dox
*.dox \
test
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
@ -1303,7 +1322,7 @@ VERBATIM_HEADERS = YES
# generated with the -Duse_libclang=ON option for CMake.
# The default value is: NO.
CLANG_ASSISTED_PARSING = YES
CLANG_ASSISTED_PARSING = NO
# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
# tag is set to YES then Doxygen will add the directory of each input to the
@ -1454,11 +1473,23 @@ HTML_EXTRA_STYLESHEET = thirdparty/doxygen-awesome-css/doxygen-awesome.css \
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_FILES = thirdparty/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \
HTML_EXTRA_FILES = doc/doc-extras.js \
thirdparty/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \
thirdparty/doxygen-awesome-css/doxygen-awesome-paragraph-link.js \
thirdparty/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \
thirdparty/doxygen-awesome-css/doxygen-awesome-interactive-toc.js \
thirdparty/doxygen-awesome-css/doxygen-awesome-tabs.js
thirdparty/doxygen-awesome-css/doxygen-awesome-tabs.js \
doc/papers/boyle-gilboa-ishai-fss-improvements-eprint-2018-707.pdf \
doc/papers/guo-yang-wang-zhang-xie-zhang-liu-half-tree-eprint-2022-1431.pdf \
doc/papers/doerner-shelat-scaling-oram-eprint-2017-827.pdf \
doc/papers/boyle-chandran-gilboa-gupta-ishai-kumar-rathee-mixed-mode-fss-eprint-2020-1392.pdf \
doc/papers/de-castro-polychroniadou-verifiable-fss-eprint-2021-580.pdf \
doc/papers/patra-schneider-suresh-yalame-aby2-eprint-2020-1225.pdf \
doc/papers/zyskind-yanai-pentland-three-party-dpf-eprint-2024-1658.pdf \
doc/papers/storrier-vadapalli-lyons-henry-grotto-eprint-2023-108.pdf \
doc/papers/boyle-gilboa-ishai-kolobov-it-dpf-eprint-2023-028.pdf \
doc/papers/chou-orlandi-simplest-ot-eprint-2015-267.pdf \
doc/papers/boyar-peralta-aes-sbox-eprint-2011-332.pdf
# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
# should be rendered with a dark or light theme.
@ -1471,7 +1502,7 @@ HTML_EXTRA_FILES = thirdparty/doxygen-awesome-css/doxygen-awesome-darkmode
# The default value is: AUTO_LIGHT.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE = AUTO_DARK
HTML_COLORSTYLE = LIGHT
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
# will adjust the colors in the style sheet and background images according to
@ -1538,7 +1569,7 @@ HTML_CODE_FOLDING = YES
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COPY_CLIPBOARD = YES
HTML_COPY_CLIPBOARD = NO
# Doxygen stores a couple of settings persistently in the browser (via e.g.
# cookies). By default these settings apply to all HTML pages generated by
@ -1809,7 +1840,7 @@ GENERATE_TREEVIEW = YES
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
PAGE_OUTLINE_PANEL = YES
PAGE_OUTLINE_PANEL = NO
# When GENERATE_TREEVIEW is set to YES, the FULL_SIDEBAR option determines if
# the side bar is limited to only the treeview area (value NO) or if it should
@ -2138,7 +2169,8 @@ PAPER_TYPE = a4
# If left blank no extra packages will be included.
# This tag requires that the tag GENERATE_LATEX is set to YES.
EXTRA_PACKAGES =
EXTRA_PACKAGES = amsmath \
amssymb
# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
# the generated LaTeX document. The header should contain everything until the
@ -2521,7 +2553,8 @@ SEARCH_INCLUDES = YES
# RECURSIVE has no effect here.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
INCLUDE_PATH = thirdparty \
INCLUDE_PATH = include \
thirdparty \
thirdparty/asio/asio/include
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
@ -2540,10 +2573,17 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = HEDLEY_ALWAYS_INLINE=[[gnu::always_inline]] \
HEDLEY_PURE=[[gnu::pure]] \
HEDLEY_CONST=[[gnu::const]] \
HEDLEY_NO_THROW=[[gnu::nothrow]] \
PREDEFINED = HEDLEY_ALWAYS_INLINE= \
HEDLEY_PURE= \
HEDLEY_CONST= \
HEDLEY_NO_THROW= \
HEDLEY_WARN_UNUSED_RESULT= \
HEDLEY_DEPRECATED_FOR(y,r)= \
HEDLEY_DIAGNOSTIC_PUSH= \
HEDLEY_DIAGNOSTIC_POP= \
HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED= \
HEDLEY_NON_NULL(x)= \
HEDLEY_PRAGMA(x)= \
psnip_int8_t=int8_t \
psnip_uint8_t=uint8_t \
psnip_int16_t=int16_t \
@ -2952,7 +2992,7 @@ PLANTUMLFILE_DIRS =
# Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_GRAPH_MAX_NODES = 50
DOT_GRAPH_MAX_NODES = 500
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# generated by dot. A depth value of 3 means that only nodes reachable from the