Skip to content

Commit

Permalink
Replace <para> tags with <simpara> tags
Browse files Browse the repository at this point in the history
  • Loading branch information
MauricioFauth committed Oct 22, 2024
1 parent e4796fd commit 4876e38
Show file tree
Hide file tree
Showing 6 changed files with 58 additions and 58 deletions.
24 changes: 12 additions & 12 deletions reference/sodium/functions/sodium-crypto-aead-aegis128l-decrypt.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
<methodparam><type>string</type><parameter>nonce</parameter></methodparam>
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Verify then decrypt a message with AEGIS-128L.
</para>
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand All @@ -26,44 +26,44 @@
<varlistentry>
<term><parameter>ciphertext</parameter></term>
<listitem>
<para>
<simpara>
Must be in the format provided by <function>sodium_crypto_aead_aegis128l_encrypt</function>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>additional_data</parameter></term>
<listitem>
<para>
<simpara>
Additional, authenticated data. This is used in the verification of the authentication tag
appended to the ciphertext, but it is not encrypted or stored in the ciphertext.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nonce</parameter></term>
<listitem>
<para>
<simpara>
A number that must be only used once, per message.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
<simpara>
Encryption key (128-bit).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the plaintext on success, &return.falseforfailure;.
</para>
</simpara>
</refsect1>

<refsect1 role="seealso">
Expand Down
24 changes: 12 additions & 12 deletions reference/sodium/functions/sodium-crypto-aead-aegis128l-encrypt.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
<methodparam><type>string</type><parameter>nonce</parameter></methodparam>
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Encrypt then authenticate a message with AEGIS-128L.
</para>
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand All @@ -26,44 +26,44 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
The plaintext message to encrypt.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>additional_data</parameter></term>
<listitem>
<para>
<simpara>
Additional, authenticated data. This is used in the verification of the authentication tag
appended to the ciphertext, but it is not encrypted or stored in the ciphertext.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nonce</parameter></term>
<listitem>
<para>
<simpara>
A number that must be only used once, per message.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
<simpara>
Encryption key (128-bit).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the ciphertext and authentication tag as a string of raw binary bytes.
</para>
</simpara>
</refsect1>

<refsect1 role="seealso">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>sodium_crypto_aead_aegis128l_keygen</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Generate a random key for use with <function>sodium_crypto_aead_aegis128l_encrypt</function> and
<function>sodium_crypto_aead_aegis128l_decrypt</function>.
</para>
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand All @@ -25,9 +25,9 @@

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a 128-bit random key.
</para>
</simpara>
</refsect1>

<refsect1 role="seealso">
Expand Down
24 changes: 12 additions & 12 deletions reference/sodium/functions/sodium-crypto-aead-aegis256-decrypt.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
<methodparam><type>string</type><parameter>nonce</parameter></methodparam>
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Verify then decrypt a message with AEGIS-256.
</para>
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand All @@ -26,44 +26,44 @@
<varlistentry>
<term><parameter>ciphertext</parameter></term>
<listitem>
<para>
<simpara>
Must be in the format provided by <function>sodium_crypto_aead_aegis256_encrypt</function>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>additional_data</parameter></term>
<listitem>
<para>
<simpara>
Additional, authenticated data. This is used in the verification of the authentication tag
appended to the ciphertext, but it is not encrypted or stored in the ciphertext.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nonce</parameter></term>
<listitem>
<para>
<simpara>
A number that must be only used once, per message.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
<simpara>
Encryption key (256-bit).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the plaintext on success, &return.falseforfailure;.
</para>
</simpara>
</refsect1>

<refsect1 role="seealso">
Expand Down
24 changes: 12 additions & 12 deletions reference/sodium/functions/sodium-crypto-aead-aegis256-encrypt.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
<methodparam><type>string</type><parameter>nonce</parameter></methodparam>
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Encrypt then authenticate a message with AEGIS-256.
</para>
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand All @@ -26,44 +26,44 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
The plaintext message to encrypt.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>additional_data</parameter></term>
<listitem>
<para>
<simpara>
Additional, authenticated data. This is used in the verification of the authentication tag
appended to the ciphertext, but it is not encrypted or stored in the ciphertext.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nonce</parameter></term>
<listitem>
<para>
<simpara>
A number that must be only used once, per message.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
<simpara>
Encryption key (256-bit).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the ciphertext and authentication tag as a string of raw binary bytes.
</para>
</simpara>
</refsect1>

<refsect1 role="seealso">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>sodium_crypto_aead_aegis256_keygen</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Generate a random key for use with <function>sodium_crypto_aead_aegis256_encrypt</function> and
<function>sodium_crypto_aead_aegis256_decrypt</function>.
</para>
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand All @@ -25,9 +25,9 @@

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a 256-bit random key.
</para>
</simpara>
</refsect1>

<refsect1 role="seealso">
Expand Down

0 comments on commit 4876e38

Please sign in to comment.