Added briefs to all Foundation and made some cleanups to docs

Conflicts: Foundation/CPArray.j Foundation/CPBundle.j Foundation/CPCountedSet.j Foundation/CPIndexSet.j Foundation/CPTimer.j Foundation/CPURLConnection.j
280north · May 30, 2009 · 8fb0abd · 8fb0abd
1 parent f6bd4dd
commit 8fb0abd
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 3 deletions.
diff --git a/Foundation/CPArray.j b/Foundation/CPArray.j
@@ -89,6 +89,8 @@
 /*! 
     @ingroup foundation
     @class CPArray
+    @brief A mutable array backed by a JavaScript Array.
+
     A mutable array class backed by a JavaScript Array.
     There is also a CPMutableArray class,
     but it is just a child class of this class with an

diff --git a/Foundation/CPBundle.j b/Foundation/CPBundle.j
@@ -27,6 +27,7 @@
 
 /*! 
     @ingroup foundation
+    @brief Groups information about an application's code & resources.
 */
 
 @implementation CPBundle : CPObject

diff --git a/Foundation/CPCountedSet.j b/Foundation/CPCountedSet.j
@@ -3,6 +3,7 @@
 
 /*!
     @ingroup foundation
+    @brief An mutable collection of objects and counts of their instances.
 */
 @implementation CPCountedSet : CPMutableSet
 {

diff --git a/Foundation/CPIndexSet.j b/Foundation/CPIndexSet.j
@@ -27,7 +27,11 @@
 /*! 
     @ingroup foundation
     @class CPIndexSet
-    Instances of this class are collections of numbers. Each integer can appear in a collection only once.
+
+    @brief A collection of unique integers (indexes).
+
+    Instances of this class are collections of numbers. Each integer can appear
+    in a collection only once.
 */
 @implementation CPIndexSet : CPObject
 {

diff --git a/Foundation/CPTimer.j b/Foundation/CPTimer.j
@@ -27,6 +27,7 @@
 
 /*! 
     @ingroup foundation
+    @brief A timer which can send a message after the given time interval.
 */
 @implementation CPTimer : CPObject
 {

diff --git a/Foundation/CPURLConnection.j b/Foundation/CPURLConnection.j
@@ -34,7 +34,8 @@ var XMLHTTPRequestUninitialized = 0,
 
 var CPURLConnectionDelegate = nil;
 
-/*
+/*!
+    @class CPURLConnection
     @ingroup foundation
 
     An interface to downloading content at a specified URL. Using one of the
@@ -76,7 +77,6 @@ var CPURLConnectionDelegate = nil;
     
     @param connection the connection that received the authentication challenge.
 */
-
 @implementation CPURLConnection : CPObject
 {
     CPURLRequest    _request;