diff options
author | Morris Jobke <hey@morrisjobke.de> | 2015-04-16 17:00:08 +0200 |
---|---|---|
committer | Morris Jobke <hey@morrisjobke.de> | 2015-04-16 17:00:08 +0200 |
commit | 7644950b48b094bfe5675348aefb7cf5747d325b (patch) | |
tree | a1792e21239a86f471da99b454134a5d8533ef77 /lib/public/contacts | |
parent | 8653da6c16597959c7bd0f0b202747ff96204575 (diff) | |
download | nextcloud-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/contacts')
-rw-r--r-- | lib/public/contacts/imanager.php | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/public/contacts/imanager.php b/lib/public/contacts/imanager.php index a745445b2c7..4b7d0f7d40a 100644 --- a/lib/public/contacts/imanager.php +++ b/lib/public/contacts/imanager.php @@ -47,6 +47,7 @@ namespace OCP\Contacts { * For updating it is mandatory to keep the id. * Without an id a new contact will be created. * + * @since 6.0.0 */ interface IManager { @@ -92,6 +93,7 @@ namespace OCP\Contacts { * @param array $searchProperties defines the properties within the query pattern should match * @param array $options - for future use. One should always have options! * @return array an array of contacts which are arrays of key-value-pairs + * @since 6.0.0 */ function search($pattern, $searchProperties = array(), $options = array()); @@ -101,6 +103,7 @@ namespace OCP\Contacts { * @param object $id the unique identifier to a contact * @param string $address_book_key identifier of the address book in which the contact shall be deleted * @return bool successful or not + * @since 6.0.0 */ function delete($id, $address_book_key); @@ -111,6 +114,7 @@ namespace OCP\Contacts { * @param array $properties this array if key-value-pairs defines a contact * @param string $address_book_key identifier of the address book in which the contact shall be created or updated * @return array an array representing the contact just created or updated + * @since 6.0.0 */ function createOrUpdate($properties, $address_book_key); @@ -118,6 +122,7 @@ namespace OCP\Contacts { * Check if contacts are available (e.g. contacts app enabled) * * @return bool true if enabled, false if not + * @since 6.0.0 */ function isEnabled(); @@ -126,6 +131,7 @@ namespace OCP\Contacts { * * @param \OCP\IAddressBook $address_book * @return void + * @since 6.0.0 */ function registerAddressBook(\OCP\IAddressBook $address_book); @@ -134,6 +140,7 @@ namespace OCP\Contacts { * * @param \OCP\IAddressBook $address_book * @return void + * @since 6.0.0 */ function unregisterAddressBook(\OCP\IAddressBook $address_book); @@ -143,17 +150,20 @@ namespace OCP\Contacts { * * @param \Closure $callable * @return void + * @since 6.0.0 */ function register(\Closure $callable); /** * @return array + * @since 6.0.0 */ function getAddressBooks(); /** * removes all registered address book instances * @return void + * @since 6.0.0 */ function clear(); } |