Skip to content

Experiment: Replace verbose synopses with phpdoc synopsis instruction #5909

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

Draft
jordikroon wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Experiment: Replace verbose synopses with phpdoc synopsis instruction #5909

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
5 changes: 1 addition & 4 deletions language/predefined/exception/clone.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Exception">
<modifier>private</modifier> <type>void</type><methodname>Exception::__clone</methodname>
<void/>
</methodsynopsis>
<?phpdoc synopsis="Exception::__clone" ?>
<simpara>
Exceptions do not support cloning; this method exists only to prevent it.
</simpara>
Expand Down
7 changes: 1 addition & 6 deletions language/predefined/exception/construct.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<constructorsynopsis role="Exception">
<modifier>public</modifier> <methodname>Exception::__construct</methodname>
<methodparam choice="opt"><type>string</type><parameter>message</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>code</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>Throwable</type><type>null</type></type><parameter>previous</parameter><initializer>&null;</initializer></methodparam>
</constructorsynopsis>
<?phpdoc synopsis="Exception::__construct" ?>
<para>
Constructs the Exception.
</para>
Expand Down
5 changes: 1 addition & 4 deletions language/predefined/exception/getcode.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Exception">
<modifier>final</modifier> <modifier>public</modifier> <type>int</type><methodname>Exception::getCode</methodname>
<void/>
</methodsynopsis>
<?phpdoc synopsis="Exception::getCode" ?>
<para>
Returns the Exception code.
</para>
Expand Down
5 changes: 1 addition & 4 deletions language/predefined/exception/getfile.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Exception">
<modifier>final</modifier> <modifier>public</modifier> <type>string</type><methodname>Exception::getFile</methodname>
<void/>
</methodsynopsis>
<?phpdoc synopsis="Exception::getFile" ?>
<para>
Get the name of the file in which the exception was created.
</para>
Expand Down
5 changes: 1 addition & 4 deletions language/predefined/exception/getline.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Exception">
<modifier>final</modifier> <modifier>public</modifier> <type>int</type><methodname>Exception::getLine</methodname>
<void/>
</methodsynopsis>
<?phpdoc synopsis="Exception::getLine" ?>
<para>
Get line number where the exception was created.
</para>
Expand Down
5 changes: 1 addition & 4 deletions language/predefined/exception/getmessage.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Exception">
<modifier>final</modifier> <modifier>public</modifier> <type>string</type><methodname>Exception::getMessage</methodname>
<void/>
</methodsynopsis>
<?phpdoc synopsis="Exception::getMessage" ?>
<para>
Returns the Exception message.
</para>
Expand Down
5 changes: 1 addition & 4 deletions language/predefined/exception/getprevious.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Exception">
<modifier>final</modifier> <modifier>public</modifier> <type class="union"><type>Throwable</type><type>null</type></type><methodname>Exception::getPrevious</methodname>
<void/>
</methodsynopsis>
<?phpdoc synopsis="Exception::getPrevious" ?>
<para>
Returns previous <classname>Throwable</classname>
(which had been passed as the third parameter of <methodname>Exception::__construct</methodname>).
Expand Down
5 changes: 1 addition & 4 deletions language/predefined/exception/gettrace.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Exception">
<modifier>final</modifier> <modifier>public</modifier> <type>array</type><methodname>Exception::getTrace</methodname>
<void/>
</methodsynopsis>
<?phpdoc synopsis="Exception::getTrace" ?>
<para>
Returns the Exception stack trace.
</para>
Expand Down
5 changes: 1 addition & 4 deletions language/predefined/exception/gettraceasstring.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Exception">
<modifier>final</modifier> <modifier>public</modifier> <type>string</type><methodname>Exception::getTraceAsString</methodname>
<void/>
</methodsynopsis>
<?phpdoc synopsis="Exception::getTraceAsString" ?>
<para>
Returns the Exception stack trace as a string.
</para>
Expand Down
5 changes: 1 addition & 4 deletions language/predefined/exception/tostring.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Exception">
<modifier>public</modifier> <type>string</type><methodname>Exception::__toString</methodname>
<void/>
</methodsynopsis>
<?phpdoc synopsis="Exception::__toString" ?>
<para>
Returns the <type>string</type> representation of the exception.
</para>
Expand Down
5 changes: 1 addition & 4 deletions reference/openssl/functions/openssl-cipher-iv-length.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>openssl_cipher_iv_length</methodname>
<methodparam><type>string</type><parameter>cipher_algo</parameter></methodparam>
</methodsynopsis>
<?phpdoc synopsis="openssl_cipher_iv_length" ?>
<para>
Gets the cipher initialization vector (iv) length.
</para>
Expand Down
5 changes: 1 addition & 4 deletions reference/openssl/functions/openssl-cipher-key-length.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>openssl_cipher_key_length</methodname>
<methodparam><type>string</type><parameter>cipher_algo</parameter></methodparam>
</methodsynopsis>
<?phpdoc synopsis="openssl_cipher_key_length" ?>
<para>
Gets the cipher key length.
</para>
Expand Down
9 changes: 1 addition & 8 deletions reference/openssl/functions/openssl-cms-decrypt.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openssl_cms_decrypt</methodname>
<methodparam><type>string</type><parameter>input_filename</parameter></methodparam>
<methodparam><type>string</type><parameter>output_filename</parameter></methodparam>
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type class="union"><type>OpenSSLCertificate</type><type>string</type></type><parameter>certificate</parameter></methodparam>
<methodparam choice="opt"><modifier role="attribute">#[\SensitiveParameter]</modifier><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type><type>null</type></type><parameter>private_key</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>encoding</parameter><initializer><constant>OPENSSL_ENCODING_SMIME</constant></initializer></methodparam>
</methodsynopsis>
<?phpdoc synopsis="openssl_cms_decrypt" ?>
<para>
Decrypts a CMS message.
</para>
Expand Down
11 changes: 1 addition & 10 deletions reference/openssl/functions/openssl-cms-encrypt.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openssl_cms_encrypt</methodname>
<methodparam><type>string</type><parameter>input_filename</parameter></methodparam>
<methodparam><type>string</type><parameter>output_filename</parameter></methodparam>
<methodparam><type class="union"><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>certificate</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>null</type></type><parameter>headers</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>encoding</parameter><initializer><constant>OPENSSL_ENCODING_SMIME</constant></initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>int</type></type><parameter>cipher_algo</parameter><initializer><constant>OPENSSL_CIPHER_AES_128_CBC</constant></initializer></methodparam>
</methodsynopsis>
<?phpdoc synopsis="openssl_cms_encrypt" ?>
<para>
This function encrypts content to one or more recipients,
based on the certificates that are passed to it.
Expand Down
6 changes: 1 addition & 5 deletions reference/openssl/functions/openssl-cms-read.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openssl_cms_read</methodname>
<methodparam><type>string</type><parameter>input_filename</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">certificates</parameter></methodparam>
</methodsynopsis>
<?phpdoc synopsis="openssl_cms_read" ?>
<para>
Performs the exact analog to <function>openssl_pkcs7_read</function>.
</para>
Expand Down
12 changes: 1 addition & 11 deletions reference/openssl/functions/openssl-cms-sign.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openssl_cms_sign</methodname>
<methodparam><type>string</type><parameter>input_filename</parameter></methodparam>
<methodparam><type>string</type><parameter>output_filename</parameter></methodparam>
<methodparam><type class="union"><type>OpenSSLCertificate</type><type>string</type></type><parameter>certificate</parameter></methodparam>
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>private_key</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>null</type></type><parameter>headers</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>encoding</parameter><initializer><constant>OPENSSL_ENCODING_SMIME</constant></initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>untrusted_certificates_filename</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<?phpdoc synopsis="openssl_cms_sign" ?>
<para>
This function signs a file with an X.509 certificate and key.
</para>
Expand Down
13 changes: 1 addition & 12 deletions reference/openssl/functions/openssl-cms-verify.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openssl_cms_verify</methodname>
<methodparam><type>string</type><parameter>input_filename</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>certificates</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>ca_info</parameter><initializer>[]</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>untrusted_certificates_filename</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>content</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>pk7</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>sigfile</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>encoding</parameter><initializer><constant>OPENSSL_ENCODING_SMIME</constant></initializer></methodparam>
</methodsynopsis>
<?phpdoc synopsis="openssl_cms_verify" ?>
<para>
This function verifies a CMS signature, either attached or detached, with the specified encoding.
</para>
Expand Down
7 changes: 1 addition & 6 deletions reference/openssl/functions/openssl-csr-export-to-file.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openssl_csr_export_to_file</methodname>
<methodparam><type class="union"><type>OpenSSLCertificateSigningRequest</type><type>string</type></type><parameter>csr</parameter></methodparam>
<methodparam><type>string</type><parameter>output_filename</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>no_text</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<?phpdoc synopsis="openssl_csr_export_to_file" ?>
<para>
<function>openssl_csr_export_to_file</function> takes the Certificate
Signing Request represented by <parameter>csr</parameter> and saves it
Expand Down
7 changes: 1 addition & 6 deletions reference/openssl/functions/openssl-csr-export.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openssl_csr_export</methodname>
<methodparam><type class="union"><type>OpenSSLCertificateSigningRequest</type><type>string</type></type><parameter>csr</parameter></methodparam>
<methodparam><type>string</type><parameter role="reference">output</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>no_text</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<?phpdoc synopsis="openssl_csr_export" ?>
<para>
<function>openssl_csr_export</function> takes the Certificate Signing
Request represented by <parameter>csr</parameter> and stores it in
Expand Down
6 changes: 1 addition & 5 deletions reference/openssl/functions/openssl-csr-get-public-key.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>OpenSSLAsymmetricKey</type><type>false</type></type><methodname>openssl_csr_get_public_key</methodname>
<methodparam><type class="union"><type>OpenSSLCertificateSigningRequest</type><type>string</type></type><parameter>csr</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>short_names</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<?phpdoc synopsis="openssl_csr_get_public_key" ?>
<para>
<function>openssl_csr_get_public_key</function> extracts the public key
from <parameter>csr</parameter> and prepares it for use by other functions.
Expand Down
6 changes: 1 addition & 5 deletions reference/openssl/functions/openssl-csr-get-subject.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>openssl_csr_get_subject</methodname>
<methodparam><type class="union"><type>OpenSSLCertificateSigningRequest</type><type>string</type></type><parameter>csr</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>short_names</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<?phpdoc synopsis="openssl_csr_get_subject" ?>
<para>
<function>openssl_csr_get_subject</function> returns subject
distinguished name information encoded in the <parameter>csr</parameter>
Expand Down
8 changes: 1 addition & 7 deletions reference/openssl/functions/openssl-csr-new.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>OpenSSLCertificateSigningRequest</type><type>bool</type></type><methodname>openssl_csr_new</methodname>
<methodparam><type>array</type><parameter>distinguished_names</parameter></methodparam>
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type class="union"><type>OpenSSLAsymmetricKey</type><type>null</type></type><parameter role="reference">private_key</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>extra_attributes</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<?phpdoc synopsis="openssl_csr_new" ?>
<para>
<function>openssl_csr_new</function> generates a new <acronym>CSR</acronym>
based on the information provided by <parameter>distinguished_names</parameter>.
Expand Down
11 changes: 1 addition & 10 deletions reference/openssl/functions/openssl-csr-sign.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>OpenSSLCertificate</type><type>false</type></type><methodname>openssl_csr_sign</methodname>
<methodparam><type class="union"><type>OpenSSLCertificateSigningRequest</type><type>string</type></type><parameter>csr</parameter></methodparam>
<methodparam><type class="union"><type>OpenSSLCertificate</type><type>string</type><type>null</type></type><parameter>ca_certificate</parameter></methodparam>
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>private_key</parameter></methodparam>
<methodparam><type>int</type><parameter>days</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>serial</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>serial_hex</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<?phpdoc synopsis="openssl_csr_sign" ?>
<para>
<function>openssl_csr_sign</function> generates an x509 certificate from the given <acronym>CSR</acronym>.
</para>
Expand Down
11 changes: 1 addition & 10 deletions reference/openssl/functions/openssl-decrypt.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>openssl_decrypt</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam><type>string</type><parameter>cipher_algo</parameter></methodparam>
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>passphrase</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>iv</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>tag</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>aad</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<?phpdoc synopsis="openssl_decrypt" ?>
<para>
Takes a raw or base64 encoded string and decrypts it using a given method and passphrase.
</para>
Expand Down
6 changes: 1 addition & 5 deletions reference/openssl/functions/openssl-dh-compute-key.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>openssl_dh_compute_key</methodname>
<methodparam><type>string</type><parameter>public_key</parameter></methodparam>
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>OpenSSLAsymmetricKey</type><parameter>private_key</parameter></methodparam>
</methodsynopsis>
<?phpdoc synopsis="openssl_dh_compute_key" ?>
<para>
The shared secret returned by <function>openssl_dh_compute_key</function> is
often used as an encryption key to secretly communicate with a remote party.
Expand Down
7 changes: 1 addition & 6 deletions reference/openssl/functions/openssl-digest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>openssl_digest</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam><type>string</type><parameter>digest_algo</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>binary</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<?phpdoc synopsis="openssl_digest" ?>
<para>
Computes a digest hash value for the given data using a given method,
and returns a raw or binhex encoded string.
Expand Down
Loading
Loading