summaryrefslogtreecommitdiffstats
path: root/lib/public/diagnostics
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2015-04-16 17:00:08 +0200
committerMorris Jobke <hey@morrisjobke.de>2015-04-16 17:00:08 +0200
commit7644950b48b094bfe5675348aefb7cf5747d325b (patch)
treea1792e21239a86f471da99b454134a5d8533ef77 /lib/public/diagnostics
parent8653da6c16597959c7bd0f0b202747ff96204575 (diff)
downloadnextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.tar.gz
nextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.zip
Add @since tags to all methods in public namespace
* enhance the app development experience - you can look up the method introduction right inside the code without searching via git blame * easier to write apps for multiple versions
Diffstat (limited to 'lib/public/diagnostics')
-rw-r--r--lib/public/diagnostics/ievent.php11
-rw-r--r--lib/public/diagnostics/ieventlogger.php10
-rw-r--r--lib/public/diagnostics/iquery.php9
-rw-r--r--lib/public/diagnostics/iquerylogger.php12
4 files changed, 42 insertions, 0 deletions
diff --git a/lib/public/diagnostics/ievent.php b/lib/public/diagnostics/ievent.php
index cff3d31f55b..733d5e4832c 100644
--- a/lib/public/diagnostics/ievent.php
+++ b/lib/public/diagnostics/ievent.php
@@ -22,29 +22,40 @@
namespace OCP\Diagnostics;
+/**
+ * Interface IEvent
+ *
+ * @package OCP\Diagnostics
+ * @since 8.0.0
+ */
interface IEvent {
/**
* @return string
+ * @since 8.0.0
*/
public function getId();
/**
* @return string
+ * @since 8.0.0
*/
public function getDescription();
/**
* @return float
+ * @since 8.0.0
*/
public function getStart();
/**
* @return float
+ * @since 8.0.0
*/
public function getEnd();
/**
* @return float
+ * @since 8.0.0
*/
public function getDuration();
}
diff --git a/lib/public/diagnostics/ieventlogger.php b/lib/public/diagnostics/ieventlogger.php
index cc10862fc79..c9b4653393b 100644
--- a/lib/public/diagnostics/ieventlogger.php
+++ b/lib/public/diagnostics/ieventlogger.php
@@ -22,12 +22,19 @@
namespace OCP\Diagnostics;
+/**
+ * Interface IEventLogger
+ *
+ * @package OCP\Diagnostics
+ * @since 8.0.0
+ */
interface IEventLogger {
/**
* Mark the start of an event
*
* @param string $id
* @param string $description
+ * @since 8.0.0
*/
public function start($id, $description);
@@ -35,6 +42,7 @@ interface IEventLogger {
* Mark the end of an event
*
* @param string $id
+ * @since 8.0.0
*/
public function end($id);
@@ -43,11 +51,13 @@ interface IEventLogger {
* @param string $description
* @param float $start
* @param float $end
+ * @since 8.0.0
*/
public function log($id, $description, $start, $end);
/**
* @return \OCP\Diagnostics\IEvent[]
+ * @since 8.0.0
*/
public function getEvents();
}
diff --git a/lib/public/diagnostics/iquery.php b/lib/public/diagnostics/iquery.php
index 78808ddc381..54853f733c9 100644
--- a/lib/public/diagnostics/iquery.php
+++ b/lib/public/diagnostics/iquery.php
@@ -22,19 +22,28 @@
namespace OCP\Diagnostics;
+/**
+ * Interface IQuery
+ *
+ * @package OCP\Diagnostics
+ * @since 8.0.0
+ */
interface IQuery {
/**
* @return string
+ * @since 8.0.0
*/
public function getSql();
/**
* @return array
+ * @since 8.0.0
*/
public function getParams();
/**
* @return float
+ * @since 8.0.0
*/
public function getDuration();
}
diff --git a/lib/public/diagnostics/iquerylogger.php b/lib/public/diagnostics/iquerylogger.php
index 8c51c35ae36..4a6a0d0704b 100644
--- a/lib/public/diagnostics/iquerylogger.php
+++ b/lib/public/diagnostics/iquerylogger.php
@@ -24,18 +24,30 @@ namespace OCP\Diagnostics;
use Doctrine\DBAL\Logging\SQLLogger;
+/**
+ * Interface IQueryLogger
+ *
+ * @package OCP\Diagnostics
+ * @since 8.0.0
+ */
interface IQueryLogger extends SQLLogger {
/**
* @param string $sql
* @param array $params
* @param array $types
+ * @since 8.0.0
*/
public function startQuery($sql, array $params = null, array $types = null);
+ /**
+ * @return mixed
+ * @since 8.0.0
+ */
public function stopQuery();
/**
* @return \OCP\Diagnostics\IQuery[]
+ * @since 8.0.0
*/
public function getQueries();
}