From 33e5f4ef7243bc1282acb1cba93e8f99c1debe68 Mon Sep 17 00:00:00 2001 From: George Peter Banyard Date: Tue, 29 Mar 2022 14:20:32 +0100 Subject: [PATCH] Fix constructorsynopsis usage in EV extension Also drop return value section Closes GH-1465. --- reference/ev/evcheck.xml | 3 ++- reference/ev/evcheck/construct.xml | 11 +++-------- reference/ev/evchild.xml | 3 ++- reference/ev/evchild/construct.xml | 11 +++-------- reference/ev/evembed.xml | 3 ++- reference/ev/evembed/construct.xml | 11 +++-------- reference/ev/evfork.xml | 3 ++- reference/ev/evfork/construct.xml | 11 +++-------- reference/ev/evidle.xml | 3 ++- reference/ev/evidle/construct.xml | 11 +++-------- reference/ev/evio.xml | 3 ++- reference/ev/evio/construct.xml | 11 +++-------- reference/ev/evloop.xml | 3 ++- reference/ev/evloop/construct.xml | 11 +++-------- reference/ev/evperiodic.xml | 3 ++- reference/ev/evperiodic/construct.xml | 11 +++-------- reference/ev/evprepare.xml | 3 ++- reference/ev/evprepare/construct.xml | 11 +++-------- reference/ev/evsignal.xml | 3 ++- reference/ev/evsignal/construct.xml | 11 +++-------- reference/ev/evstat.xml | 3 ++- reference/ev/evstat/construct.xml | 11 +++-------- reference/ev/evtimer.xml | 3 ++- reference/ev/evtimer/construct.xml | 11 +++-------- reference/ev/evwatcher.xml | 3 ++- reference/ev/evwatcher/construct.xml | 4 ++-- 26 files changed, 64 insertions(+), 111 deletions(-) diff --git a/reference/ev/evcheck.xml b/reference/ev/evcheck.xml index 13a1565f7a..3c438fef17 100644 --- a/reference/ev/evcheck.xml +++ b/reference/ev/evcheck.xml @@ -86,7 +86,8 @@ &InheritedProperties; &Methods; - + + &InheritedMethods; diff --git a/reference/ev/evcheck/construct.xml b/reference/ev/evcheck/construct.xml index 3786203326..4230b46e5f 100644 --- a/reference/ev/evcheck/construct.xml +++ b/reference/ev/evcheck/construct.xml @@ -7,7 +7,7 @@ &reftitle.description; - + public EvCheck::__construct @@ -22,7 +22,7 @@ int priority - + Constructs the EvCheck @@ -66,12 +66,7 @@ - - &reftitle.returnvalues; - - Returns EvCheck object on success. - - + &reftitle.seealso; diff --git a/reference/ev/evchild.xml b/reference/ev/evchild.xml index d460db2ce6..ade85036d5 100644 --- a/reference/ev/evchild.xml +++ b/reference/ev/evchild.xml @@ -64,7 +64,8 @@ &InheritedProperties; &Methods; - + + &InheritedMethods; diff --git a/reference/ev/evchild/construct.xml b/reference/ev/evchild/construct.xml index bf6b92c589..5438252280 100644 --- a/reference/ev/evchild/construct.xml +++ b/reference/ev/evchild/construct.xml @@ -7,7 +7,7 @@ &reftitle.description; - + public EvChild::__construct @@ -34,7 +34,7 @@ priority 0 - + Constructs the EvChild @@ -156,12 +156,7 @@ - - &reftitle.returnvalues; - - Returns EvChild object on success. - - + &reftitle.seealso; diff --git a/reference/ev/evembed.xml b/reference/ev/evembed.xml index cd0b2f1dd5..5b268a4cc1 100644 --- a/reference/ev/evembed.xml +++ b/reference/ev/evembed.xml @@ -37,7 +37,8 @@ embed &Methods; - + + &InheritedMethods; diff --git a/reference/ev/evembed/construct.xml b/reference/ev/evembed/construct.xml index d645560280..cf2bbadca3 100644 --- a/reference/ev/evembed/construct.xml +++ b/reference/ev/evembed/construct.xml @@ -7,7 +7,7 @@ &reftitle.description; - + public EvEmbed::__construct @@ -26,7 +26,7 @@ int priority - + This is a rather advanced watcher type that lets to embed one event loop into another(currently only IO events are supported in the embedded loop, @@ -99,12 +99,7 @@ - - &reftitle.returnvalues; - - Returns EvEmbed object on success. - - + &reftitle.examples; diff --git a/reference/ev/evfork.xml b/reference/ev/evfork.xml index d6568fb077..0c290e72e2 100644 --- a/reference/ev/evfork.xml +++ b/reference/ev/evfork.xml @@ -46,7 +46,8 @@ &InheritedProperties; &Methods; - + + &InheritedMethods; diff --git a/reference/ev/evfork/construct.xml b/reference/ev/evfork/construct.xml index 1dd82c1b30..89a730b573 100644 --- a/reference/ev/evfork/construct.xml +++ b/reference/ev/evfork/construct.xml @@ -7,7 +7,7 @@ &reftitle.description; - + public EvFork::__construct @@ -26,7 +26,7 @@ priority 0 - + Constructs the EvFork watcher object and starts the watcher automatically. @@ -68,12 +68,7 @@ - - &reftitle.returnvalues; - - Returns EvFork object on success. - - + &reftitle.seealso; diff --git a/reference/ev/evidle.xml b/reference/ev/evidle.xml index f6da43ccea..4e7b8be1f2 100644 --- a/reference/ev/evidle.xml +++ b/reference/ev/evidle.xml @@ -70,7 +70,8 @@ &InheritedProperties; &Methods; - + + &InheritedMethods; diff --git a/reference/ev/evidle/construct.xml b/reference/ev/evidle/construct.xml index 50e910d674..c576bf00e9 100644 --- a/reference/ev/evidle/construct.xml +++ b/reference/ev/evidle/construct.xml @@ -7,7 +7,7 @@ &reftitle.description; - + public EvIdle::__construct @@ -22,7 +22,7 @@ int priority - + Constructs the EvIdle watcher object and starts the watcher automatically. @@ -64,12 +64,7 @@ - - &reftitle.returnvalues; - - Returns EvIdle object on success. - - + &reftitle.seealso; diff --git a/reference/ev/evio.xml b/reference/ev/evio.xml index c658930107..c5c47ebfa3 100644 --- a/reference/ev/evio.xml +++ b/reference/ev/evio.xml @@ -82,7 +82,8 @@ &InheritedProperties; &Methods; - + + &InheritedMethods; diff --git a/reference/ev/evio/construct.xml b/reference/ev/evio/construct.xml index 20e5ccc873..f72c1b95e8 100644 --- a/reference/ev/evio/construct.xml +++ b/reference/ev/evio/construct.xml @@ -7,7 +7,7 @@ &reftitle.description; - + public EvIo::__construct @@ -30,7 +30,7 @@ int priority - + Constructs EvIo watcher object and starts the watcher automatically. @@ -99,12 +99,7 @@ - - &reftitle.returnvalues; - - Returns EvIo object on success. - - + &reftitle.seealso; diff --git a/reference/ev/evloop.xml b/reference/ev/evloop.xml index e53809b5fa..729d2ff6de 100644 --- a/reference/ev/evloop.xml +++ b/reference/ev/evloop.xml @@ -85,7 +85,8 @@ depth &Methods; - + + diff --git a/reference/ev/evloop/construct.xml b/reference/ev/evloop/construct.xml index baa222dfb3..0076a3ba00 100644 --- a/reference/ev/evloop/construct.xml +++ b/reference/ev/evloop/construct.xml @@ -7,7 +7,7 @@ &reftitle.description; - + public EvLoop::__construct @@ -32,7 +32,7 @@ timeout_interval 0.0 - + Constructs the event loop object. @@ -85,12 +85,7 @@ - - &reftitle.returnvalues; - - Returns new EvLoop object. - - + &reftitle.seealso; diff --git a/reference/ev/evperiodic.xml b/reference/ev/evperiodic.xml index a6e1b92369..11e1abe106 100644 --- a/reference/ev/evperiodic.xml +++ b/reference/ev/evperiodic.xml @@ -81,7 +81,8 @@ &InheritedProperties; &Methods; - + + &InheritedMethods; diff --git a/reference/ev/evperiodic/construct.xml b/reference/ev/evperiodic/construct.xml index bb74ce82b9..aea93906da 100644 --- a/reference/ev/evperiodic/construct.xml +++ b/reference/ev/evperiodic/construct.xml @@ -7,7 +7,7 @@ &reftitle.description; - + public EvPeriodic::__construct @@ -38,7 +38,7 @@ priority 0 - + Constructs EvPeriodic watcher object and starts it automatically. EvPeriodic::createStopped @@ -116,12 +116,7 @@ - - &reftitle.returnvalues; - - Returns EvPeriodic object on success. - - + &reftitle.examples; diff --git a/reference/ev/evprepare.xml b/reference/ev/evprepare.xml index c439502234..566c4cfb8f 100644 --- a/reference/ev/evprepare.xml +++ b/reference/ev/evprepare.xml @@ -32,7 +32,8 @@ &InheritedProperties; &Methods; - + + &InheritedMethods; diff --git a/reference/ev/evprepare/construct.xml b/reference/ev/evprepare/construct.xml index c91e2673bc..224dc9df81 100644 --- a/reference/ev/evprepare/construct.xml +++ b/reference/ev/evprepare/construct.xml @@ -7,7 +7,7 @@ &reftitle.description; - + public EvPrepare::__construct @@ -22,7 +22,7 @@ string priority - + Constructs EvPrepare watcher object. And starts the watcher automatically. If need a stopped watcher consider using @@ -66,12 +66,7 @@ - - &reftitle.returnvalues; - - Returns EvPrepare object on success. - - + &reftitle.seealso; diff --git a/reference/ev/evsignal.xml b/reference/ev/evsignal.xml index 366f6c3d8c..966144c5d6 100644 --- a/reference/ev/evsignal.xml +++ b/reference/ev/evsignal.xml @@ -69,7 +69,8 @@ &InheritedProperties; &Methods; - + + &InheritedMethods; diff --git a/reference/ev/evsignal/construct.xml b/reference/ev/evsignal/construct.xml index a78d58f0e4..7d7a1c84c7 100644 --- a/reference/ev/evsignal/construct.xml +++ b/reference/ev/evsignal/construct.xml @@ -7,7 +7,7 @@ &reftitle.description; - + public EvSignal::__construct @@ -30,7 +30,7 @@ priority 0 - + Constructs EvSignal watcher object and starts it automatically. For a stopped periodic watcher consider using @@ -89,12 +89,7 @@ - - &reftitle.returnvalues; - - Returns EvSignal object on success. - - + &reftitle.examples; diff --git a/reference/ev/evstat.xml b/reference/ev/evstat.xml index 69572af399..8f567fbb1a 100644 --- a/reference/ev/evstat.xml +++ b/reference/ev/evstat.xml @@ -87,7 +87,8 @@ &InheritedProperties; &Methods; - + + &InheritedMethods; diff --git a/reference/ev/evstat/construct.xml b/reference/ev/evstat/construct.xml index d92429ddd0..f57a13d867 100644 --- a/reference/ev/evstat/construct.xml +++ b/reference/ev/evstat/construct.xml @@ -7,7 +7,7 @@ &reftitle.description; - + public EvStat::__construct @@ -34,7 +34,7 @@ priority 0 - + Constructs EvStat watcher object and starts the watcher automatically. @@ -101,12 +101,7 @@ - - &reftitle.returnvalues; - - Returns EvStat watcher object on succes. - - + &reftitle.examples; diff --git a/reference/ev/evtimer.xml b/reference/ev/evtimer.xml index 0833f88da8..a3cc763508 100644 --- a/reference/ev/evtimer.xml +++ b/reference/ev/evtimer.xml @@ -74,7 +74,8 @@ &InheritedProperties; &Methods; - + + &InheritedMethods; diff --git a/reference/ev/evtimer/construct.xml b/reference/ev/evtimer/construct.xml index 32b51411b7..9e7d3d6ef3 100644 --- a/reference/ev/evtimer/construct.xml +++ b/reference/ev/evtimer/construct.xml @@ -7,7 +7,7 @@ &reftitle.description; - + public EvTimer::__construct @@ -34,7 +34,7 @@ priority 0 - + Constructs an EvTimer watcher object. @@ -102,12 +102,7 @@ - - &reftitle.returnvalues; - - Returns EvTimer object on success. - - + &reftitle.examples; diff --git a/reference/ev/evwatcher.xml b/reference/ev/evwatcher.xml index 8069e97175..864b4723ab 100644 --- a/reference/ev/evwatcher.xml +++ b/reference/ev/evwatcher.xml @@ -56,7 +56,8 @@ priority &Methods; - + + diff --git a/reference/ev/evwatcher/construct.xml b/reference/ev/evwatcher/construct.xml index 0024700cf6..ccaf2a8a94 100644 --- a/reference/ev/evwatcher/construct.xml +++ b/reference/ev/evwatcher/construct.xml @@ -7,12 +7,12 @@ &reftitle.description; - + abstract public EvWatcher::__construct - + EvWatcher::__construct is an abstract constructor of a watcher object implemented in the derived