From d82a926ca16921897f1f9b289fafd7a7c55e410a Mon Sep 17 00:00:00 2001 From: Ray Greenwell Date: Fri, 6 Nov 2009 21:18:43 +0000 Subject: [PATCH] Add an example to the docs. git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@5986 542714f4-19e9-0310-aa3c-eee0fc999fb1 --- src/as/com/threerings/io/ObjectInputStream.as | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/as/com/threerings/io/ObjectInputStream.as b/src/as/com/threerings/io/ObjectInputStream.as index 5d21db8e5..d80000101 100644 --- a/src/as/com/threerings/io/ObjectInputStream.as +++ b/src/as/com/threerings/io/ObjectInputStream.as @@ -70,6 +70,19 @@ public class ObjectInputStream * @param checkType optional type to check the read object against * @return the Object read, or null. * @throws TypeError if the object is read successfully but is the wrong type + * + * @example + * + * + * public function readObject (ins :ObjectInputStream) :void + * { + * _scoops = ins.readObject(Array); + * _coneType = ins.readObject(Cone); + * } + * + * protected var _scoops :Array; + * protected var _coneType :Cone; + * */ public function readObject (checkType :Class = null) :* //throws IOError