Skip to content

Commit ae6961f

Browse files
PhilDaiguillePhilDaiguille
authored
[Sync ES] Update XML documentation for MongoDB methods to improve clarity and consistency (#599)
1 parent e73a9de commit ae6961f

48 files changed

Lines changed: 1564 additions & 1547 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎language/types/type-juggling.xml‎

Lines changed: 174 additions & 158 deletions
Large diffs are not rendered by default.

‎language/types/void.xml‎

Lines changed: 41 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,56 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: 161dde4fe721309398dd324edbf02aec409f127b Maintainer: PhilDaiguille Status: ready -->
3-
<!-- Reviewed: no Maintainer: Marqitos -->
2+
<!-- EN-Revision: 50f76f26914c5a9e61aa26f2e36c4acb362a48fd Maintainer: PhilDaiguille Status: ready -->
3+
<!-- Reviewed: no -->
44
<sect1 xml:id="language.types.void">
55
<title>Void</title>
66

77
<para>
8-
<type>void</type> es una declaración de tipo de retorno únicamente, indicando que la función
9-
no devuelve ningún valor, pero que la función puede terminar de todos modos.
10-
Por lo tanto, no puede formar parte de una declaración de
11-
<link linkend="language.types.type-system.composite.union">tipo de unión</link>
8+
<type>void</type> es un tipo de declaración de retorno que indica que la
9+
función no devuelve ningún valor, pero la función aún puede terminar.
10+
Por lo tanto, no puede formar parte de una
11+
<link linkend="language.types.type-system.composite.union">declaración de tipo unión</link>.
1212
Disponible a partir de PHP 7.1.0.
1313
</para>
1414

1515
<note>
1616
<simpara>
17-
Aunque una función tenga un tipo de retorno <type>void</type>, siempre
18-
devolverá un valor, este valor siempre es &null;.
17+
Incluso si una función tiene un tipo de retorno <type>void</type>, seguirá
18+
devolviendo un valor; este valor siempre es &null;.
1919
</simpara>
2020
</note>
2121

22+
<sect2 xml:id="language.types.void.casting">
23+
<title>Descartar un valor con <literal>(void)</literal></title>
24+
25+
<simpara>
26+
La sintaxis <literal>(void)</literal> puede usarse para descartar
27+
explícitamente el resultado de una expresión. Esto es útil para indicar que
28+
ignorar un valor de retorno es intencional, especialmente al llamar a una
29+
función o método marcado con el atributo <classname>NoDiscard</classname>.
30+
</simpara>
31+
32+
<simpara>
33+
A diferencia de otros moldes, <literal>(void)</literal> no convierte el
34+
valor a otro tipo ni produce un valor. Es una sentencia y no puede usarse
35+
como parte de una expresión.
36+
</simpara>
37+
38+
<example>
39+
<title>Descartar un valor de retorno</title>
40+
<programlisting role="php" annotations="non-interactive">
41+
<![CDATA[
42+
<?php
43+
#[\NoDiscard]
44+
function process(): bool {
45+
return true;
46+
}
47+
48+
(void) process(); // Descartar explícitamente el valor de retorno
49+
?>
50+
]]>
51+
</programlisting>
52+
</example>
53+
</sect2>
2254
</sect1>
2355
<!-- Keep this comment at the end of the file
2456
Local variables:
@@ -37,6 +69,6 @@ sgml-local-catalogs:nil
3769
sgml-local-ecat-files:nil
3870
End:
3971
vim600: syn=xml fen fdm=syntax fdl=2 si
40-
vim: et tw=78 syn=sgml
72+
vim: et tw=78 syn=xml
4173
vi: ts=1 sw=1
4274
-->

‎reference/mongodb/bson/utcdatetime/jsonserialize.xml‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- $Revision$ -->
3-
<!-- EN-Revision: 66d301903b063375c1618d754f1570a9d38746e3 Maintainer: PhilDaiguille Status: ready -->
2+
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: PhilDaiguille Status: ready -->
43
<!-- Reviewed: no -->
5-
64
<refentry xml:id="mongodb-bson-utcdatetime.jsonserialize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
75
<refnamediv>
86
<refname>MongoDB\BSON\UTCDateTime::jsonSerialize</refname>
9-
<refpurpose>Devuelve una representación que puede ser convertida en JSON</refpurpose>
7+
<refpurpose>Devuelve una representación que puede convertirse a JSON</refpurpose>
108
</refnamediv>
119

1210
<refsect1 role="description">
@@ -24,11 +22,11 @@
2422

2523
<refsect1 role="returnvalues">
2624
&reftitle.returnvalues;
27-
<para>
28-
Devuelve datos que pueden ser serializados por <function>json_encode</function>
29-
para producir una representación JSON extendida de
25+
<simpara>
26+
Devuelve datos que pueden ser serializados por <function>json_encode</function> para
27+
producir una representación JSON extendida de la
3028
<classname>MongoDB\BSON\UTCDateTime</classname>.
31-
</para>
29+
</simpara>
3230
&mongodb.note.extended-json;
3331
</refsect1>
3432

@@ -46,7 +44,7 @@
4644
<member><function>json_encode</function></member>
4745
<member><function>MongoDB\BSON\toCanonicalExtendedJSON</function></member>
4846
<member><function>MongoDB\BSON\toRelaxedExtendedJSON</function></member>
49-
<member><link xlink:href="&url.mongodb.docs.extendedjson;">MongoDB JSON Extendido</link></member>
47+
<member><link xlink:href="&url.mongodb.docs.extendedjson;">MongoDB Extended JSON</link></member>
5048
</simplelist>
5149
</refsect1>
5250

‎reference/mongodb/bson/utcdatetime/todatetime.xml‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- $Revision$ -->
3-
<!-- EN-Revision: c9ff64ac878c34562858be79626e533a1ccaf072 Maintainer: PhilDaiguille Status: ready -->
2+
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: PhilDaiguille Status: ready -->
43
<!-- Reviewed: no -->
5-
64
<refentry xml:id="mongodb-bson-utcdatetime.todatetime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
75
<refnamediv>
86
<refname>MongoDB\BSON\UTCDateTime::toDateTime</refname>
@@ -12,7 +10,7 @@
1210
<refsect1 role="description">
1311
&reftitle.description;
1412
<methodsynopsis>
15-
<modifier>final</modifier> <modifier>public</modifier> <type>DateTime</type><methodname>MongoDB\BSON\UTCDatetime::toDateTime</methodname>
13+
<modifier>final</modifier> <modifier>public</modifier> <type>DateTime</type><methodname>MongoDB\BSON\UTCDateTime::toDateTime</methodname>
1614
<void />
1715
</methodsynopsis>
1816
</refsect1>
@@ -24,10 +22,11 @@
2422

2523
<refsect1 role="returnvalues">
2624
&reftitle.returnvalues;
27-
<para>
28-
Devuelve la representación <classname>DateTime</classname> de este UTCDateTime.
29-
El <classname>DateTime</classname> devuelto utilizará el huso horario UTC.
30-
</para>
25+
<simpara>
26+
Devuelve la representación <classname>DateTime</classname> de este
27+
UTCDateTime. El <classname>DateTime</classname> devuelto utilizará la zona
28+
horaria UTC.
29+
</simpara>
3130
</refsect1>
3231

3332
<refsect1 role="errors">
@@ -40,7 +39,7 @@
4039
<refsect1 role="examples">
4140
&reftitle.examples;
4241
<example>
43-
<title>Ejemplo con <function>MongoDB\BSON\UTCDatetime::toDateTime</function></title>
42+
<title>Ejemplo de <function>MongoDB\BSON\UTCDatetime::toDateTime</function></title>
4443
<programlisting role="php">
4544
<![CDATA[
4645
<?php
@@ -74,7 +73,7 @@ object(DateTimeZone)#3 (2) {
7473
&reftitle.seealso;
7574
<simplelist>
7675
<member><methodname>MongoDB\BSON\UTCDateTime::toDateTimeImmutable</methodname></member>
77-
<member><link xlink:href="&url.mongodb.docs.bson;#date">El tipo BSON : Date</link></member>
76+
<member><link xlink:href="&url.mongodb.docs.bson;#date">Tipos BSON: Fecha</link></member>
7877
</simplelist>
7978
</refsect1>
8079

‎reference/mongodb/bson/utcdatetime/todatetimeimmutable.xml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: c9ff64ac878c34562858be79626e533a1ccaf072 Maintainer: PhilDaiguille Status: ready -->
2+
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: PhilDaiguille Status: ready -->
33
<!-- Reviewed: no -->
44
<refentry xml:id="mongodb-bson-utcdatetime.todatetimeimmutable" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
55
<refnamediv>
66
<refname>MongoDB\BSON\UTCDateTime::toDateTimeImmutable</refname>
7-
<refpurpose>Devuelve la representación DateTimeImmutable de esta UTCDateTime</refpurpose>
7+
<refpurpose>Devuelve la representación DateTimeImmutable de este UTCDateTime</refpurpose>
88
</refnamediv>
99

1010
<refsect1 role="description">
@@ -22,11 +22,11 @@
2222

2323
<refsect1 role="returnvalues">
2424
&reftitle.returnvalues;
25-
<para>
26-
Devuelve la representación <classname>DateTimeImmutable</classname> de esta
27-
UTCDateTime. El <classname>DateTimeImmutable</classname> devuelto utilizará
28-
el huso horario UTC.
29-
</para>
25+
<simpara>
26+
Devuelve la representación <classname>DateTimeImmutable</classname> de este
27+
UTCDateTime. El <classname>DateTimeImmutable</classname> devuelto utilizará la zona
28+
horaria UTC.
29+
</simpara>
3030
</refsect1>
3131

3232
<refsect1 role="errors">
@@ -73,7 +73,7 @@ object(DateTimeZone)#3 (2) {
7373
&reftitle.seealso;
7474
<simplelist>
7575
<member><methodname>MongoDB\BSON\UTCDateTime::toDateTime</methodname></member>
76-
<member><link xlink:href="&url.mongodb.docs.bson;#date">Tipos BSON : Date</link></member>
76+
<member><link xlink:href="&url.mongodb.docs.bson;#date">Tipos BSON: Fecha</link></member>
7777
</simplelist>
7878
</refsect1>
7979

‎reference/mongodb/bson/utcdatetime/tostring.xml‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- $Revision$ -->
3-
<!-- EN-Revision: 6ff13d6d3795fd73f8dd57ee92743b967c5fd0d0 Maintainer: PhilDaiguille Status: ready -->
2+
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: PhilDaiguille Status: ready -->
43
<!-- Reviewed: no -->
5-
64
<refentry xml:id="mongodb-bson-utcdatetime.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
75
<refnamediv>
86
<refname>MongoDB\BSON\UTCDateTime::__toString</refname>
@@ -24,15 +22,15 @@
2422

2523
<refsect1 role="returnvalues">
2624
&reftitle.returnvalues;
27-
<para>
25+
<simpara>
2826
Devuelve la representación en forma de string de este UTCDateTime.
29-
</para>
27+
</simpara>
3028
</refsect1>
3129

3230
<refsect1 role="examples">
3331
&reftitle.examples;
3432
<example>
35-
<title>Ejemplo con <function>MongoDB\BSON\UTCDatetime::__toString</function></title>
33+
<title>Ejemplo de <function>MongoDB\BSON\UTCDateTime::__toString</function></title>
3634
<programlisting role="php">
3735
<![CDATA[
3836
<?php
@@ -55,7 +53,7 @@ string(13) "1416445411987"
5553
<refsect1 role="seealso">
5654
&reftitle.seealso;
5755
<simplelist>
58-
<member><link xlink:href="&url.mongodb.docs.bson;#date">BSON Types: Date</link></member>
56+
<member><link xlink:href="&url.mongodb.docs.bson;#date">Tipos BSON: Fecha</link></member>
5957
</simplelist>
6058
</refsect1>
6159

‎reference/mongodb/bson/utcdatetimeinterface/todatetime.xml‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- $Revision$ -->
3-
<!-- EN-Revision: e9366ee458b2900c53a503b1ad97664e1d9a8859 Maintainer: PhilDaiguille Status: ready -->
2+
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: PhilDaiguille Status: ready -->
43
<!-- Reviewed: no -->
5-
64
<refentry xml:id="mongodb-bson-utcdatetimeinterface.todatetime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
75
<refnamediv>
86
<refname>MongoDB\BSON\UTCDateTimeInterface::toDateTime</refname>
9-
<refpurpose>Devuelve la representación DateTime de UTCDateTimeInterface</refpurpose>
7+
<refpurpose>Devuelve la representación DateTime de esta UTCDateTimeInterface</refpurpose>
108
</refnamediv>
119

1210
<refsect1 role="description">
@@ -24,11 +22,11 @@
2422

2523
<refsect1 role="returnvalues">
2624
&reftitle.returnvalues;
27-
<para>
25+
<simpara>
2826
Devuelve la representación <classname>DateTime</classname> de esta
29-
UTCDateTimeInterface. El <classname>DateTime</classname> debería utilizar
30-
el huso horario UTC.
31-
</para>
27+
UTCDateTimeInterface. El <classname>DateTime</classname> devuelto debe usar
28+
la zona horaria UTC.
29+
</simpara>
3230
</refsect1>
3331

3432
<refsect1 role="seealso">

‎reference/mongodb/bson/utcdatetimeinterface/todatetimeimmutable.xml‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: 4639881688d3faaf0073ad71fe0a4b730aea15a0 Maintainer: PhilDaiguille Status: ready -->
2+
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: PhilDaiguille Status: ready -->
33
<!-- Reviewed: no -->
4-
54
<refentry xml:id="mongodb-bson-utcdatetimeinterface.todatetimeimmutable" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
65
<refnamediv>
76
<refname>MongoDB\BSON\UTCDateTimeInterface::toDateTimeImmutable</refname>
8-
<refpurpose>Devuelve la representación DateTimeImmutable de esta UTCDateTimeInterface</refpurpose>
7+
<refpurpose>Devuelve la representación DateTimeImmutable de esta interfaz UTCDateTimeInterface</refpurpose>
98
</refnamediv>
109

1110
<refsect1 role="description">
@@ -23,10 +22,10 @@
2322

2423
<refsect1 role="returnvalues">
2524
&reftitle.returnvalues;
26-
<para>
25+
<simpara>
2726
Devuelve la representación <classname>DateTimeImmutable</classname> de esta
28-
UTCDateTimeInterface. La <classname>DateTimeImmutable</classname> devuelta utilizará la zona horaria UTC.
29-
</para>
27+
interfaz UTCDateTimeInterface. El <classname>DateTimeImmutable</classname> devuelto utilizará la zona horaria UTC.
28+
</simpara>
3029
</refsect1>
3130

3231
<refsect1 role="seealso">

‎reference/mongodb/bson/utcdatetimeinterface/tostring.xml‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- $Revision$ -->
3-
<!-- EN-Revision: e9366ee458b2900c53a503b1ad97664e1d9a8859 Maintainer: PhilDaiguille Status: ready -->
2+
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: PhilDaiguille Status: ready -->
43
<!-- Reviewed: no -->
5-
64
<refentry xml:id="mongodb-bson-utcdatetimeinterface.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
75
<refnamediv>
86
<refname>MongoDB\BSON\UTCDateTimeInterface::__toString</refname>
9-
<refpurpose>Devuelve la representación en forma de string de UTCDateTimeInterface</refpurpose>
7+
<refpurpose>Devuelve la representación en string de esta UTCDateTimeInterface</refpurpose>
108
</refnamediv>
119

1210
<refsect1 role="description">
@@ -24,9 +22,9 @@
2422

2523
<refsect1 role="returnvalues">
2624
&reftitle.returnvalues;
27-
<para>
28-
Devuelve la representación en forma de string de UTCDateTimeInterface.
29-
</para>
25+
<simpara>
26+
Devuelve la representación en string de esta UTCDateTimeInterface.
27+
</simpara>
3028
</refsect1>
3129

3230
<refsect1 role="seealso">

0 commit comments

Comments
 (0)