Merge pull request #4 from norzechowicz/docblocks

Norbert Orzechowicz · Norbert Orzechowicz · commit 06ee621e792a · 2015-09-03T23:12:21.000+02:00
Marked API methods with @api docblock
diff --git a/src/Isolate/LazyObjects/Exception/Exception.php b/src/Isolate/LazyObjects/Exception/Exception.php
@@ -2,6 +2,9 @@
 
 namespace Isolate\LazyObjects\Exception;
 
+/**
+ * @api
+ */
 class Exception extends \Exception
 {
 }
diff --git a/src/Isolate/LazyObjects/Exception/InvalidArgumentException.php b/src/Isolate/LazyObjects/Exception/InvalidArgumentException.php
@@ -2,6 +2,9 @@
 
 namespace Isolate\LazyObjects\Exception;
 
+/**
+ * @api
+ */
 class InvalidArgumentException extends Exception
 {
 }
diff --git a/src/Isolate/LazyObjects/Exception/NotExistingPropertyException.php b/src/Isolate/LazyObjects/Exception/NotExistingPropertyException.php
@@ -2,6 +2,9 @@
 
 namespace Isolate\LazyObjects\Exception;
 
+/**
+ * @api
+ */
 class NotExistingPropertyException extends Exception
 {
 }
diff --git a/src/Isolate/LazyObjects/Exception/RuntimeException.php b/src/Isolate/LazyObjects/Exception/RuntimeException.php
@@ -2,6 +2,9 @@
 
 namespace Isolate\LazyObjects\Exception;
 
+/**
+ * @api
+ */
 class RuntimeException extends Exception
 {
 }
diff --git a/src/Isolate/LazyObjects/Object/Property/Initializer.php b/src/Isolate/LazyObjects/Object/Property/Initializer.php
@@ -6,6 +6,9 @@
 use Isolate\LazyObjects\Object\PropertyAccessor;
 use Isolate\LazyObjects\Proxy\LazyProperty;
 
+/**
+ * @api
+ */
 final class Initializer
 {
     /**
@@ -29,6 +32,8 @@ public function __construct()
      * @param string $triggerMethod
      * @param $targetObject
      * @throws InvalidArgumentException
+     * 
+     * @api
      */
     public function initialize($lazyProperties = [], $triggerMethod, $targetObject)
     {
diff --git a/src/Isolate/LazyObjects/Object/PropertyAccessor.php b/src/Isolate/LazyObjects/Object/PropertyAccessor.php
@@ -7,6 +7,9 @@
 use Isolate\LazyObjects\Object\Value\Assembler;
 use Isolate\LazyObjects\Object\Value\AssemblerFactory;
 
+/**
+ * @api
+ */
 class PropertyAccessor
 {
     /**
@@ -15,6 +18,8 @@ class PropertyAccessor
      * @param $value
      * @throws InvalidArgumentException
      * @throws NotExistingPropertyException
+     * 
+     * @api
      */
     public function set($object, $propertyName, $value)
     {
@@ -32,6 +37,8 @@ public function set($object, $propertyName, $value)
      * @return mixed
      * @throws InvalidArgumentException
      * @throws NotExistingPropertyException
+     * 
+     * @api
      */
     public function get($object, $propertyName)
     {
diff --git a/src/Isolate/LazyObjects/Proxy/ClassName.php b/src/Isolate/LazyObjects/Proxy/ClassName.php
@@ -4,6 +4,9 @@
 
 use Isolate\LazyObjects\Exception\InvalidArgumentException;
 
+/**
+ * @api
+ */
 class ClassName
 {
     /**
@@ -35,6 +38,8 @@ public function __toString()
     /**
      * @param $object
      * @return bool
+     * 
+     * @api
      */
     public function itFits($object)
     {
diff --git a/src/Isolate/LazyObjects/Proxy/Definition.php b/src/Isolate/LazyObjects/Proxy/Definition.php
@@ -4,6 +4,9 @@
 
 use Isolate\LazyObjects\Exception\InvalidArgumentException;
 
+/**
+ * @api
+ */
 class Definition
 {
     /**
@@ -39,6 +42,8 @@ public function __construct(ClassName $className, array $lazyProperties = [], ar
 
     /**
      * @return ClassName
+     * 
+     * @api
      */
     public function getClassName()
     {
@@ -48,6 +53,8 @@ public function getClassName()
     /**
      * @param $object
      * @return bool
+     * 
+     * @api
      */
     public function describeProxyFor($object)
     {
@@ -56,6 +63,8 @@ public function describeProxyFor($object)
 
     /**
      * @return array|LazyProperty[]
+     * 
+     * @api
      */
     public function getLazyProperties()
     {
@@ -64,6 +73,8 @@ public function getLazyProperties()
 
     /**
      * @return array
+     * 
+     * @api
      */
     public function getMethodReplacements()
     {
diff --git a/src/Isolate/LazyObjects/Proxy/Factory.php b/src/Isolate/LazyObjects/Proxy/Factory.php
@@ -2,12 +2,17 @@
 
 namespace Isolate\LazyObjects\Proxy;
 
+/**
+ * @api
+ */
 interface Factory
 {
     /**
      * @param mixed $object
      * @param Definition $definition
      * @return mixed $object
+     * 
+     * @api
      */
     public function createProxy($object, Definition $definition);
 }
diff --git a/src/Isolate/LazyObjects/Proxy/LazyProperty.php b/src/Isolate/LazyObjects/Proxy/LazyProperty.php
@@ -7,6 +7,9 @@
 use Isolate\LazyObjects\Proxy\Property\Name;
 use Isolate\LazyObjects\Proxy\Property\ValueInitializer;
 
+/**
+ * @api
+ */
 class LazyProperty
 {
     /**
@@ -50,6 +53,8 @@ public function __construct(Name $name, ValueInitializer $valueInitializer, $tri
 
     /**
      * @return ValueInitializer
+     * 
+     * @api
      */
     public function getValueInitializer()
     {
@@ -58,6 +63,8 @@ public function getValueInitializer()
 
     /**
      * @return string
+     * 
+     * @api
      */
     public function getName()
     {
@@ -66,6 +73,8 @@ public function getName()
 
     /**
      * @return bool
+     * 
+     * @api
      */
     public function hasTriggers()
     {
@@ -75,6 +84,8 @@ public function hasTriggers()
     /**
      * @param $methodName
      * @return bool
+     * 
+     * @api
      */
     public function isTriggeredBy($methodName)
     {
@@ -89,6 +100,8 @@ public function isTriggeredBy($methodName)
 
     /**
      * @param InitializationCallback $initializationCallback
+     * 
+     * @api
      */
     public function setInitializationCallback(InitializationCallback $initializationCallback)
     {
@@ -97,6 +110,8 @@ public function setInitializationCallback(InitializationCallback $initialization
 
     /**
      * @return bool
+     * 
+     * @api
      */
     public function hasInitializationCallback()
     {
@@ -105,6 +120,8 @@ public function hasInitializationCallback()
 
     /**
      * @return InitializationCallback
+     * 
+     * @api
      */
     public function getInitializationCallback()
     {
diff --git a/src/Isolate/LazyObjects/Proxy/LazyProperty/InitializationCallback.php b/src/Isolate/LazyObjects/Proxy/LazyProperty/InitializationCallback.php
@@ -2,12 +2,17 @@
 
 namespace Isolate\LazyObjects\Proxy\LazyProperty;
 
+/**
+ * @api
+ */
 interface InitializationCallback 
 {
     /**
      * @param mixed $defaultValue
      * @param mixed $newValue
      * @param mixed $targetObject
+     * 
+     * @api
      */
     public function execute($defaultValue, $newValue, $targetObject);
 }
diff --git a/src/Isolate/LazyObjects/Proxy/Method.php b/src/Isolate/LazyObjects/Proxy/Method.php
@@ -4,6 +4,9 @@
 
 use Isolate\LazyObjects\Exception\InvalidArgumentException;
 
+/**
+ * @api
+ */
 class Method
 {
     /**
@@ -36,6 +39,8 @@ public function __toString()
     /**
      * @param $method
      * @return bool
+     * 
+     * @api
      */
     public function isEqualTo($method)
     {
diff --git a/src/Isolate/LazyObjects/Proxy/Method/Replacement.php b/src/Isolate/LazyObjects/Proxy/Method/Replacement.php
@@ -4,6 +4,9 @@
 
 use Isolate\LazyObjects\WrappedObject;
 
+/**
+ * @api
+ */
 interface Replacement
 {
     /**
@@ -14,6 +17,8 @@ interface Replacement
      * @param string $methodName
      * @param array $params
      * @return mixed
+     * 
+     * @api
      */
     public function execute(WrappedObject $proxy, $methodName, array $params = []);
 }
diff --git a/src/Isolate/LazyObjects/Proxy/MethodReplacement.php b/src/Isolate/LazyObjects/Proxy/MethodReplacement.php
@@ -4,6 +4,9 @@
 
 use Isolate\LazyObjects\Proxy\Method\Replacement;
 
+/**
+ * @api
+ */
 class MethodReplacement
 {
     /**
@@ -27,6 +30,8 @@ public function __construct(Method $method, Replacement $replacement)
 
     /**
      * @return Replacement
+     * 
+     * @api
      */
     public function getReplacement()
     {
@@ -35,6 +40,8 @@ public function getReplacement()
 
     /**
      * @return Method
+     * 
+     * @api
      */
     public function getMethod()
     {
diff --git a/src/Isolate/LazyObjects/Proxy/Property/Name.php b/src/Isolate/LazyObjects/Proxy/Property/Name.php
@@ -4,6 +4,9 @@
 
 use Isolate\LazyObjects\Exception\InvalidArgumentException;
 
+/**
+ * @api
+ */
 class Name
 {
     /**
diff --git a/src/Isolate/LazyObjects/Proxy/Property/ValueInitializer.php b/src/Isolate/LazyObjects/Proxy/Property/ValueInitializer.php
@@ -2,6 +2,9 @@
 
 namespace Isolate\LazyObjects\Proxy\Property;
 
+/**
+ * @api
+ */
 interface ValueInitializer
 {
     /**
@@ -12,6 +15,8 @@ interface ValueInitializer
      * @param mixed $object that property holds the property.
      * @param mixed $defaultPropertyValue default of property that was set before initialization
      * @return mixed
+     * 
+     * @api
      */
     public function initialize($object, $defaultPropertyValue);
 }
diff --git a/src/Isolate/LazyObjects/WrappedObject.php b/src/Isolate/LazyObjects/WrappedObject.php
@@ -5,20 +5,29 @@
 use Isolate\LazyObjects\Proxy\LazyProperty;
 use Isolate\LazyObjects\Proxy\MethodReplacement;
 
+/**
+ * @api
+ */
 interface WrappedObject
 {
     /**
      * @return mixed
+     * 
+     * @api
      */
     public function getWrappedObject();
 
     /**
      * @return array|LazyProperty[]
+     * 
+     * @api
      */
     public function getLazyProperties();
 
     /**
      * @return array|MethodReplacement[]
+     * 
+     * @api
      */
     public function getMethodReplacements();
 }
diff --git a/src/Isolate/LazyObjects/Wrapper.php b/src/Isolate/LazyObjects/Wrapper.php

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace Isolate\LazyObjects\Exception;`
`4`	`4`
	`5`	`+/**`
	`6`	`+ * @api`
	`7`	`+ */`
`5`	`8`	`class Exception extends \Exception`
`6`	`9`	`{`
`7`	`10`	`}`