From 2b5933015e8f445e86d492cc44487feb5735d841 Mon Sep 17 00:00:00 2001
From: Ray Greenwell <ray@threerings.net>
Date: Tue, 4 Dec 2007 03:24:52 +0000
Subject: [PATCH] Some documentation.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@4899 542714f4-19e9-0310-aa3c-eee0fc999fb1
---
 src/as/com/threerings/util/ClassUtil.as | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/as/com/threerings/util/ClassUtil.as b/src/as/com/threerings/util/ClassUtil.as
index 9105a118a..9d0a1cc78 100644
--- a/src/as/com/threerings/util/ClassUtil.as
+++ b/src/as/com/threerings/util/ClassUtil.as
@@ -27,11 +27,17 @@ import flash.utils.getDefinitionByName;
 
 public class ClassUtil
 {
+    /**
+     * Get the full class name, e.g. "com.threerings.util.ClassUtil".
+     */
     public static function getClassName (obj :Object) :String
     {
         return getQualifiedClassName(obj).replace("::", ".");
     }
 
+    /**
+     * Get the class name with the last part of the package, e.g. "util.ClassUtil".
+     */
     public static function shortClassName (obj :Object) :String
     {
         var s :String = getQualifiedClassName(obj);
@@ -40,6 +46,9 @@ public class ClassUtil
         return s.replace("::", ".");
     }
 
+    /**
+     * Get just the class name, e.g. "ClassUtil".
+     */
     public static function tinyClassName (obj :Object) :String
     {
         var s :String = getClassName(obj);