Skip to content

Fixed documentation strings so the docs site can build #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Fixed documentation strings so the docs site can build #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion include/session/config/base.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -655,7 +655,7 @@ class ConfigBase : public ConfigSig {
/// - `value` -- replaces current value with given string view
void operator=(std::string_view value) { *this = std::string{value}; }

/// API: base/ConfigBase::DictFieldProxy::operator=(std::span<const unsigned char>)
/// API: base/ConfigBase::DictFieldProxy::operator
///
/// Replaces the current value with the given std::span<const unsigned char>. This also
/// auto-vivifies any intermediate dicts needed to reach the given key, including replacing
Expand Down Expand Up @@ -1263,6 +1263,9 @@ class ConfigBase : public ConfigSig {
///
/// Note that only *incomplete* partial sets are affected by this (and stored); we also
/// separately retain metadata about *completed* multipart sets (see MULTIPART_MAX_REMEMBER).
///
/// Inputs: None
///
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is caused by missing /// Member variable. (fixed in #45)

std::chrono::milliseconds MULTIPART_MAX_WAIT = 7 * 24h;

/// API: base/ConfigBase::MULTIPART_MAX_REMEMBER
Expand All @@ -1272,6 +1275,9 @@ class ConfigBase : public ConfigSig {
///
/// Unlike MULTIPART_MAX_WAIT, such storage does not include the data itself, but merely the
/// (final) config hash and timestamp of the recombined parts needed for deduplication.
///
/// Inputs: None
///
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Likewise

std::chrono::milliseconds MULTIPART_MAX_REMEMBER = 14 * 24h;

/// API: base/ConfigBase::add_key
Expand Down
3 changes: 3 additions & 0 deletions include/session/config/encrypt.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ void encrypt_inplace(
///
/// That is, for some message `m`, encrypt_overhead() is the difference between m.size() and
/// encrypt(m).size().
///
/// Inputs: None
///
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is indeed a parser problem; I've added a change in #45 that recognizes this as a constant automatically, but also adds a new /// Constant. stanza in cases where the constant might be too complex.

constexpr size_t ENCRYPT_DATA_OVERHEAD = 40; // ABYTES + NPUBBYTES

/// Thrown if decrypt() fails.
Expand Down