Browse Source

Merge pull request #67 from pylebecq/master

Added documentation for the @VirtualProperty annotation
Johannes 12 years ago
parent
commit
8352df3e5a
1 changed files with 8 additions and 0 deletions
  1. 8 0
      doc/reference/annotations.rst

+ 8 - 0
doc/reference/annotations.rst

@@ -141,6 +141,14 @@ default the order is undefined, but you may change it to either "alphabetical",
         private $name;
     }
 
+@VirtualProperty
+~~~~~~~~~~~~~~~~
+This annotation can be defined on a method to indicate that the data returned by
+the method should appear like a property of the object.
+
+**Note**: This only works for serialization and is completely ignored during
+deserialization.
+
 @Inline
 ~~~~~~~~
 This annotation can be defined on a property to indicate that the data of the property