Add an example to the docs.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@5986 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Ray Greenwell
2009-11-06 21:18:43 +00:00
parent a707c8b515
commit d82a926ca1
@@ -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
* <listing version="3.0">
*
* public function readObject (ins :ObjectInputStream) :void
* {
* _scoops = ins.readObject(Array);
* _coneType = ins.readObject(Cone);
* }
*
* protected var _scoops :Array;
* protected var _coneType :Cone;
* </listing>
*/
public function readObject (checkType :Class = null) :*
//throws IOError