sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add exception info for componere

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344438 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Joe Watkins 2018-03-04 07:59:02 +00:00
parent 771eb5cea1
commit 4d298e618c
30 changed files with 194 additions and 203 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
reference/componere/componere/abstract/definition/addinterface.xml
View file

@ -40,6 +40,14 @@
</para>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>RuntimeException</type> if <type>Definition</type> was registered
</para>
</warning>
</refsect1>
</refentry>

16
reference/componere/componere/abstract/definition/addmethod.xml
View file

@ -35,7 +35,7 @@
<term><parameter>method</parameter></term>
<listitem>
<para>
\Componere\Method not previously added to another \Componere\Abstract\Definition
<type>\Componere\Method</type> not previously added to another <type>Definition</type>
</para>
</listitem>
</varlistentry>
@ -49,6 +49,20 @@
</para>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>RuntimeException</type> if <type>Definition</type> was registered
</para>
</warning>
<warning>
<para>
Shall throw <type>RuntimeException</type> if Method was added to another Definition
</para>
</warning>
</refsect1>
</refentry>

9
reference/componere/componere/abstract/definition/addtrait.xml
View file

@ -40,6 +40,15 @@
</para>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>RuntimeException</type> if <type>Definition</type> was registered
</para>
</warning>
</refsect1>
</refentry>

5
reference/componere/componere/abstract/definition/getreflector.xml
View file

@ -19,11 +19,6 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

24
reference/componere/componere/definition/addconstant.xml
View file

@ -17,7 +17,6 @@
<para>
Shall declare a class constant on the current Definition
</para>
</refsect1>
<refsect1 role="parameters">
@ -49,6 +48,29 @@
</para>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>RuntimeException</type> if <type>Definition</type> was registered
</para>
</warning>
<warning>
<para>
Shall throw <type>RuntimeException</type> if <parameter>name</parameter> is already declared as a constant
</para>
</warning>
<warning>
<para>
Shall throw <type>RuntimeException</type> if <parameter>value</parameter> is static
</para>
</warning>
<warning>
<para>
Shall throw <type>RuntimeException</type> if <parameter>value</parameter> is undefined
</para>
</warning>
</refsect1>
</refentry>

13
reference/componere/componere/definition/addproperty.xml
View file

@ -49,6 +49,19 @@
</para>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>RuntimeException</type> if <type>Definition</type> was registered
</para>
</warning>
<warning>
<para>
Shall throw <type>RuntimeException</type> if <parameter>name</parameter> is already declared as a property
</para>
</warning>
</refsect1>
</refentry>

29
reference/componere/componere/definition/construct.xml
View file

@ -65,6 +65,35 @@
</variablelist>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>InvalidArgumentException</type> if an attempt is made to replace an internal class
</para>
</warning>
<warning>
<para>
Shall throw <type>InvalidArgumentException</type> if an attempt is made to replace an interface
</para>
</warning>
<warning>
<para>
Shall throw <type>InvalidArgumentException</type> if an attempt is made to replace a trait
</para>
</warning>
<warning>
<para>
Shall throw <type>RuntimeException</type> if a class in <parameter>interfaces</parameter> cannot be found
</para>
</warning>
<warning>
<para>
Shall throw <type>RuntimeException</type> if an class in <parameter>interfaces</parameter> is not an interface
</para>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

13
reference/componere/componere/definition/getclosure.xml
View file

@ -40,6 +40,19 @@
</para>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>RuntimeException</type> if <type>Definition</type> was registered
</para>
</warning>
<warning>
<para>
Shall throw <type>RuntimeException</type> if <parameter>name</parameter> could not be found
</para>
</warning>
</refsect1>
</refentry>

13
reference/componere/componere/definition/getclosures.xml
View file

@ -19,11 +19,6 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@ -31,6 +26,14 @@
</para>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>RuntimeException</type> if <type>Definition</type> was registered
</para>
</warning>
</refsect1>
</refentry>

6
reference/componere/componere/definition/isregistered.xml
View file

@ -16,12 +16,6 @@
<para>
Shall detect the registration state of this Definition
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">

18
reference/componere/componere/definition/register.xml
View file

@ -19,19 +19,15 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>RuntimeException</type> if <type>Definition</type> was registered
</para>
</warning>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

11
reference/componere/componere/method/construct.xml
View file

@ -30,17 +30,6 @@
</variablelist>
</refsect1>
<!-- Return values commented out, as constructors generally don't return a
value. Uncomment this if you do need a return values section (for
example, because there's also a procedural version of the method).
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
-->
</refentry>

6
reference/componere/componere/method/getreflector.xml
View file

@ -16,12 +16,6 @@
<para>
Shall create or return a ReflectionMethod
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">

17
reference/componere/componere/method/setprivate.xml
View file

@ -13,15 +13,6 @@
<modifier>public</modifier> <type>Method</type><methodname>Componere\Method::setPrivate</methodname>
<void />
</methodsynopsis>
<para>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
@ -31,6 +22,14 @@
</para>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>RuntimeException</type> if access level was previously set
</para>
</warning>
</refsect1>
</refentry>

18
reference/componere/componere/method/setprotected.xml
View file

@ -13,15 +13,6 @@
<modifier>public</modifier> <type>Method</type><methodname>Componere\Method::setProtected</methodname>
<void />
</methodsynopsis>
<para>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
@ -31,6 +22,15 @@
</para>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>RuntimeException</type> if access level was previously set
</para>
</warning>
</refsect1>
</refentry>

9
reference/componere/componere/method/setstatic.xml
View file

@ -13,15 +13,6 @@
<modifier>public</modifier> <type>Method</type><methodname>Componere\Method::setStatic</methodname>
<void />
</methodsynopsis>
<para>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">

12
reference/componere/componere/patch/apply.xml
View file

@ -19,18 +19,6 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
</refentry>

28
reference/componere/componere/patch/construct.xml
View file

@ -43,18 +43,24 @@
</variablelist>
</refsect1>
<!-- Return values commented out, as constructors generally don't return a
value. Uncomment this if you do need a return values section (for
example, because there's also a procedural version of the method).
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>InvalidArgumentException</type> if the type of <parameter>instance</parameter> is an internal class
</para>
</warning>
<warning>
<para>
Shall throw <type>RuntimeException</type> if a class in <parameter>interfaces</parameter> cannot be found
</para>
</warning>
<warning>
<para>
Shall throw <type>RuntimeException</type> if an class in <parameter>interfaces</parameter> is not an interface
</para>
</warning>
</refsect1>
-->
</refentry>

9
reference/componere/componere/patch/getclosure.xml
View file

@ -40,6 +40,15 @@
</para>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>RuntimeException</type> if <parameter>name</parameter> could not be found
</para>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

5
reference/componere/componere/patch/getclosures.xml
View file

@ -19,11 +19,6 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

16
reference/componere/componere/patch/isapplied.xml
View file

@ -13,22 +13,6 @@
<modifier>public</modifier> <type>bool</type><methodname>Componere\Patch::isApplied</methodname>
<void />
</methodsynopsis>
<para>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>

13
reference/componere/componere/patch/revert.xml
View file

@ -19,19 +19,6 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

18
reference/componere/componere/value/construct.xml
View file

@ -23,7 +23,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>value</parameter></term>
<term><parameter>default</parameter></term>
<listitem>
<para>
@ -33,16 +33,14 @@
</variablelist>
</refsect1>
<!-- Return values commented out, as constructors generally don't return a
value. Uncomment this if you do need a return values section (for
example, because there's also a procedural version of the method).
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>InvalidArgumentException</type> if <parameter>default</parameter> does not have a suitable value
</para>
</warning>
</refsect1>
-->

12
reference/componere/componere/value/hasdefault.xml
View file

@ -19,18 +19,6 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
</refentry>

12
reference/componere/componere/value/isprivate.xml
View file

@ -19,18 +19,6 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
</refentry>

12
reference/componere/componere/value/isprotected.xml
View file

@ -19,18 +19,6 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
</refentry>

12
reference/componere/componere/value/isstatic.xml
View file

@ -19,18 +19,6 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
</refentry>

14
reference/componere/componere/value/setprivate.xml
View file

@ -19,11 +19,6 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@ -31,6 +26,15 @@
</para>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>RuntimeException</type> if access level was previously set
</para>
</warning>
</refsect1>
</refentry>

14
reference/componere/componere/value/setprotected.xml
View file

@ -19,11 +19,6 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@ -31,6 +26,15 @@
</para>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>RuntimeException</type> if access level was previously set
</para>
</warning>
</refsect1>
</refentry>

5
reference/componere/componere/value/setstatic.xml
View file

@ -19,11 +19,6 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>