diff --git a/AppKit/CPAnimation.j b/AppKit/CPAnimation.j index bbdb79c69..6b943279f 100644 --- a/AppKit/CPAnimation.j +++ b/AppKit/CPAnimation.j @@ -68,7 +68,7 @@ ACTUAL_FRAME_RATE = 0; @param animation the animation that was stopped @delegate - (float)animation:(CPAnimation)animation valueForProgress:(float)progress; - The value from this method will be returned when CPAnimation's + The value from this method will be returned when CPAnimation's currentValue method is called. @param animation the animation to obtain the curve value for @param progress the current animation progress diff --git a/AppKit/CPApplication.j b/AppKit/CPApplication.j index 73fd8c0fe..2063b889f 100644 --- a/AppKit/CPApplication.j +++ b/AppKit/CPApplication.j @@ -230,7 +230,7 @@ CPRunContinuesResponse = -1002; /*! This method is called by run before the event loop begins. When it successfully completes, it posts the notification - CPApplicationDidFinishLaunchingNotification. If you override + CPApplicationDidFinishLaunchingNotification. If you override finishLaunching, the subclass method should invoke the superclass method. */ - (void)finishLaunching @@ -437,7 +437,7 @@ CPRunContinuesResponse = -1002; } /*! - Returns the CPWindow object corresponding to aWindowNumber. + Returns the CPWindow object corresponding to aWindowNumber. */ - (CPWindow)windowWithWindowNumber:(int)aWindowNumber { @@ -445,7 +445,7 @@ CPRunContinuesResponse = -1002; } /*! - Returns an array of the application's CPWindows + Returns an array of the application's CPWindows */ - (CPArray)windows { @@ -599,7 +599,7 @@ CPRunContinuesResponse = -1002;
  1. a responder from the key window
  2. a responder frmo the main window
  3. -
  4. the CPApplication instance
  5. +
  6. the CPApplication instance
  7. the application delegate
  8. the document controller
diff --git a/AppKit/CPButton.j b/AppKit/CPButton.j index f179c2be1..f170c39d6 100644 --- a/AppKit/CPButton.j +++ b/AppKit/CPButton.j @@ -222,7 +222,7 @@ var _CPButtonClassName = nil, /*! @class CPButton - CPButton is a subclass of CPControl that + CPButton is a subclass of CPControl that intercepts mouse-down events and sends an action message to a target object when it's clicked or pressed. */ @@ -252,7 +252,7 @@ var _CPButtonClassName = nil, } /*! - Initializes the CPButton class. + Initializes the CPButton class. @ignore */ + (void)initialize @@ -437,7 +437,7 @@ var _CPButtonClassName = nil, /*! Sets the button's state to aState. - @param aState Possible states are any of the CPButton globals: + @param aState Possible states are any of the CPButton globals: CPOffState, CPOnState, CPMixedState */ - (void)setState:(int)aState @@ -830,7 +830,7 @@ var CPButtonImageKey = @"CPButtonImageKey", /*! Initializes the button by unarchiving data from aCoder. - @param aCoder the coder containing the archived CPButton. + @param aCoder the coder containing the archived CPButton. */ - (id)initWithCoder:(CPCoder)aCoder { diff --git a/AppKit/CPClipView.j b/AppKit/CPClipView.j index 70638ac65..2a8e029ed 100644 --- a/AppKit/CPClipView.j +++ b/AppKit/CPClipView.j @@ -27,8 +27,8 @@ /*! @class CPClipView - CPClipView allows you to define a clip rect and display only that portion of its containing view. - It is used to hold the document view in a CPScrollView. + CPClipView allows you to define a clip rect and display only that portion of its containing view. + It is used to hold the document view in a CPScrollView. */ @implementation CPClipView : CPView { @@ -134,7 +134,7 @@ } /*! - Handles a CPViewBoundsDidChangeNotification. + Handles a CPViewBoundsDidChangeNotification. @param aNotification the notification event */ - (void)viewBoundsChanged:(CPNotification)aNotification @@ -143,7 +143,7 @@ } /*! - Handles a CPViewFrameDidChangeNotification. + Handles a CPViewFrameDidChangeNotification. @param aNotification the notification event */ - (void)viewFrameChanged:(CPNotification)aNotification diff --git a/AppKit/CPCollectionView.j b/AppKit/CPCollectionView.j index e1e537dcd..6efb2b266 100644 --- a/AppKit/CPCollectionView.j +++ b/AppKit/CPCollectionView.j @@ -57,7 +57,7 @@ Invoked to obtain the data types supported by the specified indices for placement on the pasteboard. @param collectionView the collection view the items reside in @param indices the indices to obtain drag types - @return an array of drag types (CPString) + @return an array of drag types (CPString) */ @implementation CPCollectionView : CPView { @@ -567,7 +567,7 @@ @end /*! - Represents an object inside a CPCollectionView. + Represents an object inside a CPCollectionView. */ @implementation CPCollectionViewItem : CPObject { diff --git a/AppKit/CPColor.j b/AppKit/CPColor.j index 5a5eb98c1..6ea15fad9 100644 --- a/AppKit/CPColor.j +++ b/AppKit/CPColor.j @@ -48,7 +48,7 @@ var _hueComponent = 0,

The class does not have a set: method like NextStep based frameworks to change the color of the current context. To change the color of the current - context, use CGContextSetFillColor(). + context, use CGContextSetFillColor(). */ @implementation CPColor : CPObject { @@ -227,7 +227,7 @@ var _hueComponent = 0, } /*! - Creates a CPColor from a valid CSS RGB string. Example, "rgb(32,64,129)". + Creates a CPColor from a valid CSS RGB string. Example, "rgb(32,64,129)". @param aString a CSS color string @return a color initialized to the value in the css string @@ -511,7 +511,7 @@ var CPColorComponentsKey = @"CPColorComponentsKey", var hexCharacters = "0123456789ABCDEF"; /*! - Used for the CPColor colorWithHexString: implementation + Used for the CPColor colorWithHexString: implementation @ignore @class CPColor @return an array of rgb components diff --git a/AppKit/CPColorPicker.j b/AppKit/CPColorPicker.j index 6bc05e442..344a78ecb 100644 --- a/AppKit/CPColorPicker.j +++ b/AppKit/CPColorPicker.j @@ -25,7 +25,7 @@ /*! @class CPColorPicker - CPColorPicker is an abstract superclass for all color picker subclasses. If you want a particular color picker, use CPColorPanel's setPickerMode: method. The simplest way to implement your own color picker is to create a subclass of CPColorPicker. + CPColorPicker is an abstract superclass for all color picker subclasses. If you want a particular color picker, use CPColorPanel's setPickerMode: method. The simplest way to implement your own color picker is to create a subclass of CPColorPicker. */ @implementation CPColorPicker : CPObject { diff --git a/AppKit/CPColorWell.j b/AppKit/CPColorWell.j index cc605e841..6cee93020 100644 --- a/AppKit/CPColorWell.j +++ b/AppKit/CPColorWell.j @@ -31,9 +31,9 @@ var _CPColorWellDidBecomeExclusiveNotification = @"_CPColorWellDidBecomeExclusiv /*! @class CPColorWell - CPColorWell is a CPControl for selecting and displaying a single color value. An example of a CPColorWell object (or simply color well) is found in CPColorPanel, which uses a color well to display the current color selection.

+ CPColorWell is a CPControl for selecting and displaying a single color value. An example of a CPColorWell object (or simply color well) is found in CPColorPanel, which uses a color well to display the current color selection.

-

An application can have one or more active CPColorWells. You can activate multiple CPColorWells by invoking the activate: method with NO as its argument. When a mouse-down event occurs on an CPColorWell's border, it becomes the only active color well. When a color well becomes active, it brings up the color panel also. +

An application can have one or more active CPColorWells. You can activate multiple CPColorWells by invoking the activate: method with NO as its argument. When a mouse-down event occurs on an CPColorWell's border, it becomes the only active color well. When a color well becomes active, it brings up the color panel also. */ @implementation CPColorWell : CPControl { @@ -136,7 +136,7 @@ var _CPColorWellDidBecomeExclusiveNotification = @"_CPColorWellDidBecomeExclusiv // Activating and Deactivating Color Wells /*! Activates the color well, displays the color panel, and makes the panel's current color the same as its own. - If exclusive is YES, deactivates any other CPColorWells. NO, keeps them active. + If exclusive is YES, deactivates any other CPColorWells. NO, keeps them active. @param shouldBeExclusive whether other color wells should be deactivated. */ - (void)activate:(BOOL)shouldBeExclusive @@ -262,7 +262,7 @@ var CPColorWellColorKey = "CPColorWellColorKey", /*! Initializes the color well by unarchiving data from aCoder. - @param aCoder the coder containing the archived CPColorWell. + @param aCoder the coder containing the archived CPColorWell. */ - (id)initWithCoder:(CPCoder)aCoder { diff --git a/AppKit/CPControl.j b/AppKit/CPControl.j index 39613c47a..acba74bed 100644 --- a/AppKit/CPControl.j +++ b/AppKit/CPControl.j @@ -82,7 +82,7 @@ var CPControlBlackColor = [CPColor blackColor]; /*! @class CPControl - CPControl is an abstract superclass used to implement user interface elements. As a subclass of CPView and CPResponder it has the ability to handle screen drawing and handling user input. + CPControl is an abstract superclass used to implement user interface elements. As a subclass of CPView and CPResponder it has the ability to handle screen drawing and handling user input. */ @implementation CPControl : CPView { diff --git a/AppKit/CPCookie.j b/AppKit/CPCookie.j index 460e92040..8845b3b41 100644 --- a/AppKit/CPCookie.j +++ b/AppKit/CPCookie.j @@ -25,7 +25,7 @@ /*! @class CPCookie - CPCookie is the Cappuccino interface to a web browser cookie. You can set the name + CPCookie is the Cappuccino interface to a web browser cookie. You can set the name */ @implementation CPCookie : CPObject { diff --git a/AppKit/CPDocument.j b/AppKit/CPDocument.j index 27274a1da..b8a0a3fa1 100644 --- a/AppKit/CPDocument.j +++ b/AppKit/CPDocument.j @@ -82,10 +82,10 @@ var CPDocumentUntitledCount = 0; /*! @class CPDocument - CPDocument is used to represent a document/file in a Cappuccino application. + CPDocument is used to represent a document/file in a Cappuccino application. In a document-based application, generally multiple documents are open simutaneously (multiple text documents, slide presentations, spreadsheets, etc.), and multiple - CPDocuments should be used to represent this. + CPDocuments should be used to represent this. */ @implementation CPDocument : CPResponder { @@ -543,7 +543,7 @@ var CPDocumentUntitledCount = 0; // Working with Undo Manager /*! Returns YES if the document has a - CPUndoManager. + CPUndoManager. */ - (BOOL)hasUndoManager { @@ -551,7 +551,7 @@ var CPDocumentUntitledCount = 0; } /*! - Sets whether the document should have a CPUndoManager. + Sets whether the document should have a CPUndoManager. @param aFlag YES makes the document have an undo manager */ - (void)setHasUndoManager:(BOOL)aFlag @@ -649,7 +649,7 @@ var CPDocumentUntitledCount = 0; } /* - Implemented as a delegate of a CPWindow + Implemented as a delegate of a CPWindow @ignore */ - (CPUndoManager)windowWillReturnUndoManager:(CPWindow)aWindow diff --git a/AppKit/CPDocumentController.j b/AppKit/CPDocumentController.j index 4bde36b86..dcc3fc7e4 100644 --- a/AppKit/CPDocumentController.j +++ b/AppKit/CPDocumentController.j @@ -40,7 +40,7 @@ var CPSharedDocumentController = nil; /*! Returns the singleton instance of the application's document controller. If it has not been created yet, it will be created then returned. - @return a CPDocumentController + @return a CPDocumentController */ + (id)sharedDocumentController { @@ -294,7 +294,7 @@ var CPSharedDocumentController = nil; } /*! - Returns the CPDocument subclass associated with aType. + Returns the CPDocument subclass associated with aType. @param aType the type of document @return a Cappuccino Class object, or nil if no match was found */ diff --git a/AppKit/CPDragServer.j b/AppKit/CPDragServer.j index 8ef08829d..d0fc4f33f 100644 --- a/AppKit/CPDragServer.j +++ b/AppKit/CPDragServer.j @@ -116,7 +116,7 @@ var CPDragServerUpdateDragging = function(anEvent) } /* - CPDraggingInfo is a container of information about a specific dragging session. + CPDraggingInfo is a container of information about a specific dragging session. @ignore */ @implementation CPDraggingInfo : CPObject diff --git a/AppKit/CPEvent.j b/AppKit/CPEvent.j index db61a604c..61140c6cb 100644 --- a/AppKit/CPEvent.j +++ b/AppKit/CPEvent.j @@ -180,7 +180,7 @@ var _CPEventPeriodicEventPeriod = 0, _CPEventPeriodicEventTimer = nil; /*! @class CPEvent - CPEvent encapsulates the details of a Cappuccino keyboard or mouse event. + CPEvent encapsulates the details of a Cappuccino keyboard or mouse event. */ @implementation CPEvent : CPObject { @@ -206,18 +206,18 @@ var _CPEventPeriodicEventPeriod = 0, /*! Creates a new keyboard event. - @param anEventType the event type. Must be one of CPKeyDown, CPKeyUp or CPFlagsChanged + @param anEventType the event type. Must be one of CPKeyDown, CPKeyUp or CPFlagsChanged @param aPoint the location of the cursor in the window specified by aWindowNumber - @param modifierFlags a bitwise combination of the modifiers specified in the CPEvent globals + @param modifierFlags a bitwise combination of the modifiers specified in the CPEvent globals @param aTimestamp the time the event occurred - @param aWindowNumber the number of the CPWindow where the event occurred + @param aWindowNumber the number of the CPWindow where the event occurred @param aGraphicsContext the graphics context where the event occurred @param characters the characters associated with the event @param unmodCharacters the string of keys pressed without the presence of any modifiers other than Shift @param repeatKey YES if this is caused by the system repeat as opposed to the user pressing the key again @param code a number associated with the keyboard key of this event - @throws CPInternalInconsistencyException if anEventType is not a CPKeyDown, - CPKeyUp or CPFlagsChanged + @throws CPInternalInconsistencyException if anEventType is not a CPKeyDown, + CPKeyUp or CPFlagsChanged @return the keyboard event */ + (CPEvent)keyEventWithType:(CPEventType)anEventType location:(CGPoint)aPoint modifierFlags:(unsigned int)modifierFlags @@ -233,9 +233,9 @@ var _CPEventPeriodicEventPeriod = 0, Creates a new mouse event @param anEventType the event type @param aPoint the location of the cursor in the window specified by aWindowNumber - @param modifierFlags a bitwise combination of the modifiers specified in the CPEvent globals + @param modifierFlags a bitwise combination of the modifiers specified in the CPEvent globals @param aTimestamp the time the event occurred - @param aWindowNumber the number of the CPWindow where the event occurred + @param aWindowNumber the number of the CPWindow where the event occurred @param aGraphicsContext the graphics context where the event occurred @param anEventNumber a number for this event @param aClickCount the number of clicks that caused this event @@ -253,11 +253,11 @@ var _CPEventPeriodicEventPeriod = 0, /*! Creates a new custom event - @param anEventType the event type. Must be one of CPAppKitDefined, CPSystemDefined, CPApplicationDefined or CPPeriodic + @param anEventType the event type. Must be one of CPAppKitDefined, CPSystemDefined, CPApplicationDefined or CPPeriodic @param aLocation the location of the cursor in the window specified by aWindowNumber - @param modifierFlags a bitwise combination of the modifiers specified in the CPEvent globals + @param modifierFlags a bitwise combination of the modifiers specified in the CPEvent globals @param aTimestamp the time the event occurred - @param aWindowNumber the number of the CPWindow where the event occurred + @param aWindowNumber the number of the CPWindow where the event occurred @param aGraphicsContext the graphics context where the event occurred @param aSubtype a numeric identifier to differentiate this event from other custom events @param aData1 more data that describes the event diff --git a/AppKit/CPFont.j b/AppKit/CPFont.j index b233036f5..49439ca54 100644 --- a/AppKit/CPFont.j +++ b/AppKit/CPFont.j @@ -27,7 +27,7 @@ var _CPFonts = {}; /*! @class CPFont - The CPFont class allows control of the fonts used for displaying text anywhere on the screen. The primary method for getting a particular font is through one of the class methods that take a name and/or size as arguments, and return the appropriate CPFont. + The CPFont class allows control of the fonts used for displaying text anywhere on the screen. The primary method for getting a particular font is through one of the class methods that take a name and/or size as arguments, and return the appropriate CPFont. */ @implementation CPFont : CPObject { diff --git a/AppKit/CPGeometry.j b/AppKit/CPGeometry.j index ca1c3118a..a87ad1b8d 100644 --- a/AppKit/CPGeometry.j +++ b/AppKit/CPGeometry.j @@ -206,8 +206,8 @@ function CPSizeMake(width, height) } /*! - Returns YES if the CGRect, aRect, contains - the CGPoint, aPoint. + Returns YES if the CGRect, aRect, contains + the CGPoint, aPoint. @param aRect the rectangle to test with @param aPoint the point to test with @group CGRect @@ -222,11 +222,11 @@ function CPRectContainsPoint(aRect, aPoint) } /*! - Returns a BOOL indicating whether CGRect possibleOuter - contains CGRect possibleInner. + Returns a BOOL indicating whether CGRect possibleOuter + contains CGRect possibleInner. @group CGRect - @param possibleOuter the CGRect to test if possibleInner is inside of - @param possibleInner the CGRect to test if it fits inside possibleOuter. + @param possibleOuter the CGRect to test if possibleInner is inside of + @param possibleInner the CGRect to test if it fits inside possibleOuter. @return BOOL YES if possibleInner fits inside possibleOuter. */ function CPRectContainsRect(lhsRect, rhsRect) @@ -235,11 +235,11 @@ function CPRectContainsRect(lhsRect, rhsRect) } /*! - Tests whether the two CGPoints are equal to each other by comparing their + Tests whether the two CGPoints are equal to each other by comparing their x and y members. @group @CGPoint - @param lhsPoint the first CGPoint to check - @param rhsPoint the second CGPoint to check + @param lhsPoint the first CGPoint to check + @param rhsPoint the second CGPoint to check @return BOOL YES if the two points have the same x's, and the same y's. */ function CPPointEqualToPoint(lhsPoint, rhsPoint) @@ -248,10 +248,10 @@ function CPPointEqualToPoint(lhsPoint, rhsPoint) } /*! - Test whether the two CGRects have the same origin and size + Test whether the two CGRects have the same origin and size @group CGRect - @param lhsRect the first CGRect to compare - @param rhsRect the second CGRect to compare + @param lhsRect the first CGRect to compare + @param rhsRect the second CGRect to compare @return BOOL YES if the two rectangles have the same origin and size. NO, otherwise. */ function CPRectEqualToRect(lhsRect, rhsRect) @@ -262,7 +262,7 @@ function CPRectEqualToRect(lhsRect, rhsRect) /*! @group CGRect - @param aRect a CGRect + @param aRect a CGRect @return int */ function CPRectGetHeight(aRect) @@ -272,7 +272,7 @@ function CPRectGetHeight(aRect) /*! @group CGRect - @param aRect a CGRect + @param aRect a CGRect @return int */ function CPRectGetMaxX(aRect) @@ -282,7 +282,7 @@ function CPRectGetMaxX(aRect) /*! @group CGRect - @param aRect a CGRect + @param aRect a CGRect @return int */ function CPRectGetMaxY(aRect) @@ -292,7 +292,7 @@ function CPRectGetMaxY(aRect) /*! @group CGRect - @param aRect a CGRect + @param aRect a CGRect @return float */ function CPRectGetMidX(aRect) @@ -302,7 +302,7 @@ function CPRectGetMidX(aRect) /*! @group CGRect - @param aRect a CGRect + @param aRect a CGRect @return float */ function CPRectGetMidY(aRect) @@ -312,7 +312,7 @@ function CPRectGetMidY(aRect) /*! @group CGRect - @param aRect a CGRect + @param aRect a CGRect @return int */ function CPRectGetMinX(aRect) @@ -322,7 +322,7 @@ function CPRectGetMinX(aRect) /*! @group CGRect - @param aRect a CGRect + @param aRect a CGRect @return int */ function CPRectGetMinY(aRect) @@ -332,7 +332,7 @@ function CPRectGetMinY(aRect) /*! @group CGRect - @param aRect a CGRect + @param aRect a CGRect @return int */ function CPRectGetWidth(aRect) @@ -343,8 +343,8 @@ function CPRectGetWidth(aRect) /*! Returns YES if the two rectangles intersect @group CGRect - @param lhsRect the first CGRect - @param rhsRect the second CGRect + @param lhsRect the first CGRect + @param rhsRect the second CGRect @return BOOL YES if the two rectangles have any common spaces, and NO, otherwise. */ function CPRectIntersectsRect(lhsRect, rhsRect) @@ -353,11 +353,11 @@ function CPRectIntersectsRect(lhsRect, rhsRect) } /*! - Returns YES if the CGRect has no area. + Returns YES if the CGRect has no area. The test is performed by checking if the width and height are both zero. @group CGRect - @param aRect the CGRect to test - @return BOOL YES if the CGRect has no area, and NO, otherwise. + @param aRect the CGRect to test + @return BOOL YES if the CGRect has no area, and NO, otherwise. */ function CPRectIsEmpty(aRect) { @@ -365,10 +365,10 @@ function CPRectIsEmpty(aRect) } /*! - Returns YES if the CGRect has no area. + Returns YES if the CGRect has no area. The test is performed by checking if the width and height are both zero. @group CGRect - @return BOOL YES if the CGRect has no area, and NO, otherwise. + @return BOOL YES if the CGRect has no area, and NO, otherwise. */ function CPRectIsNull(aRect) { @@ -376,10 +376,10 @@ function CPRectIsNull(aRect) } /*! - Returns YES if the two CGSizes are identical. + Returns YES if the two CGSizes are identical. @group CGSize - @param lhsSize the first CGSize to compare - @param rhsSize the second CGSize to compare + @param lhsSize the first CGSize to compare + @param rhsSize the second CGSize to compare @return BOOL YES if the two sizes are identical. NO, otherwise. */ function CPSizeEqualToSize(lhsSize, rhsSize) @@ -388,10 +388,10 @@ function CPSizeEqualToSize(lhsSize, rhsSize) } /*! - Returns a human readable string of the provided CGPoint. + Returns a human readable string of the provided CGPoint. @group CGPoint @param aPoint the point to represent - @return CGPoint a string representation of the CGPoint + @return CGPoint a string representation of the CGPoint */ function CPStringFromPoint(aPoint) { @@ -399,10 +399,10 @@ function CPStringFromPoint(aPoint) } /*! - Returns a human readable string of the provided CGSize. + Returns a human readable string of the provided CGSize. @group CGSize @param aSize the size to represent - @return CGSize a string representation of the CGSize + @return CGSize a string representation of the CGSize */ function CPStringFromSize(aSize) { @@ -410,7 +410,7 @@ function CPStringFromSize(aSize) } /*! - Returns a human readable string of the provided CGRect. + Returns a human readable string of the provided CGRect. @group CGRect @param aRect the rectangle to represent @return CGString the string representation of the rectangle @@ -421,7 +421,7 @@ function CPStringFromRect(aRect) } /*! - Returns a CGPoint from a string with a comma separated pair of integers. + Returns a CGPoint from a string with a comma separated pair of integers. @group CGPoint @param aString a string containing two comma separated integers @return CGPoint the point object created from the string @@ -434,7 +434,7 @@ function CPPointFromString(aString) } /*! - Returns a CGSize from a string containing a pair of comma separated integers. + Returns a CGSize from a string containing a pair of comma separated integers. @group CGSize @param aString a string containing two comma separated integers @return CGSize the size object created from the string @@ -447,7 +447,7 @@ function CPSizeFromString(aString) } /*! - Returns a CGRect created from a string. + Returns a CGRect created from a string. @group CGRect @param aString a string in the form generated by CPStringFromRect @return CGRect the rectangle created from the string @@ -470,7 +470,7 @@ function CPPointFromEvent(anEvent) } /*! - Returns a zero sized CGSize. + Returns a zero sized CGSize. @group CGSize @return CGSize a size object with zeros for width and height */ diff --git a/AppKit/CPImage.j b/AppKit/CPImage.j index b0c24bdb9..7c4a050c3 100644 --- a/AppKit/CPImage.j +++ b/AppKit/CPImage.j @@ -49,7 +49,7 @@ CPImageDidLoadNotification = @"CPImageDidLoadNotification"; /*! @class CPImage - CPImage is used to represent images in the Cappuccino framework. It supports loading + CPImage is used to represent images in the Cappuccino framework. It supports loading all image types supported by the browser. @par Delegate Methods diff --git a/AppKit/CPMenu.j b/AppKit/CPMenu.j index 34884c07f..aa8a0984a 100644 --- a/AppKit/CPMenu.j +++ b/AppKit/CPMenu.j @@ -368,7 +368,7 @@ var _CPMenuBarVisible = NO, /*! Returns the index of the specified menu item @param aMenuItem the item to find the index for - @return the item index or CPNotFound + @return the item index or CPNotFound */ - (int)indexOfItem:(CPMenuItem)aMenuItem { @@ -381,7 +381,7 @@ var _CPMenuBarVisible = NO, /*! Returns the index of the item with the specified title. @param aTitle the desired title to match - @return the index of the item or CPNotFound + @return the index of the item or CPNotFound */ - (int)indexOfItemWithTitle:(CPString)aTitle { @@ -398,7 +398,7 @@ var _CPMenuBarVisible = NO, /*! Returns the index of the item with the specified tag @param aTag the desired tag to match - @return the index of the item or CPNotFound + @return the index of the item or CPNotFound */ - (int)indexOfItemWithTag:(int)aTag { @@ -416,7 +416,7 @@ var _CPMenuBarVisible = NO, Returns the index of the item with the specified target and action. @param aTarget the target of the desired menu item @param anAction the action of the desired menu item - @return the index of the item or CPNotFound + @return the index of the item or CPNotFound */ - (int)indexOfItemWithTarget:(id)aTarget andAction:(SEL)anAction { @@ -437,7 +437,7 @@ var _CPMenuBarVisible = NO, /*! Returns the index of the menu item with the specified represented object. @param anObject the represented object of the desired item - @return the index of the item or CPNotFound + @return the index of the item or CPNotFound */ - (int)indexOfItemWithRepresentedObject:(id)anObject { @@ -454,7 +454,7 @@ var _CPMenuBarVisible = NO, /*! Returns the index of the item with the specified submenu. @param the submenu of the desired menu item - @return the index of the item or CPNotFound + @return the index of the item or CPNotFound */ - (int)indexOfItemWithSubmenu:(CPMenu)aMenu { diff --git a/AppKit/CPMenuItem.j b/AppKit/CPMenuItem.j index be7b166bd..543f2ca46 100644 --- a/AppKit/CPMenuItem.j +++ b/AppKit/CPMenuItem.j @@ -30,7 +30,7 @@ /*! @class CPMenuItem - A CPMenuItem is added to a CPMenu. + A CPMenuItem is added to a CPMenu. It has an action and a target for that action to be sent to whenever the item is 'activated'. */ @@ -284,9 +284,9 @@ /*! Sets the state of the menu item. Possible states are:

-CPMixedState
-CPOnState
-CPOffState
+CPMixedState
+CPOnState
+CPOffState
 
*/ - (void)setState:(int)aState @@ -304,9 +304,9 @@ /*! Returns the menu item's current state. Possible states are:
-CPMixedState
-CPOnState
-CPOffState
+CPMixedState
+CPOnState
+CPOffState
 
*/ - (int)state @@ -520,10 +520,10 @@ Sets the modifier mask used for the item's keyboard shortcut. Can be a combination of:
-CPShiftKeyMask
-CPAlternateKeyMask
-CPCommandKeyMask
-CPControlKeyMask
+CPShiftKeyMask
+CPAlternateKeyMask
+CPCommandKeyMask
+CPControlKeyMask
 
*/ - (void)setKeyEquivalentModifierMask:(unsigned)aMask @@ -535,10 +535,10 @@ Returns the item's keyboard shortcut modifier mask. Can be a combination of:
-CPShiftKeyMask
-CPAlternateKeyMask
-CPCommandKeyMask
-CPControlKeyMask
+CPShiftKeyMask
+CPAlternateKeyMask
+CPCommandKeyMask
+CPControlKeyMask
 
*/ - (unsigned)keyEquivalentModifierMask diff --git a/AppKit/CPOutlineView.j b/AppKit/CPOutlineView.j index a2af0bfb9..d82d737c9 100644 --- a/AppKit/CPOutlineView.j +++ b/AppKit/CPOutlineView.j @@ -24,7 +24,7 @@ /*! @ignore - This class is a subclass of CPTableView which provides the user with a way to display + This class is a subclass of CPTableView which provides the user with a way to display tree structured data in an outline format. It is particularly useful for displaying hierarchical data such as a class inheritance tree or any other set of relationships. */ @@ -52,10 +52,10 @@ @ignore Sets the outline's data source. The data source must implement the following methods:
-- (id)outlineView:(CPOutlineView)outlineView child:(int)index ofItem:(id)item
-- (BOOL)outlineView:(CPOutlineView)outlineView isItemExpandable:(id)item
-- (int)outlineView:(CPOutlineView)outlineView numberOfChildrenOfItem:(id)item
-- (id)outlineView:(CPOutlineView)outlineView objectValueForTableColumn:(CPTableColumn)tableColumn byItem:(id)item
+- (id)outlineView:(CPOutlineView)outlineView child:(int)index ofItem:(id)item
+- (BOOL)outlineView:(CPOutlineView)outlineView isItemExpandable:(id)item
+- (int)outlineView:(CPOutlineView)outlineView numberOfChildrenOfItem:(id)item
+- (id)outlineView:(CPOutlineView)outlineView objectValueForTableColumn:(CPTableColumn)tableColumn byItem:(id)item
 
@param aDataSource the outline's data source @throws CPInternalInconsistencyException if the data source does not implement all the required methods diff --git a/AppKit/CPPanel.j b/AppKit/CPPanel.j index 93798d28e..72c7c9712 100644 --- a/AppKit/CPPanel.j +++ b/AppKit/CPPanel.j @@ -28,7 +28,7 @@ CPCancelButton = 0; /*! @class CPPanel - The CPPanel class defines objects that manage the panels of the Cappuccino user interface. A panel is a window that serves an auxiliary function within an application. It generally displays controls that the user can act on to give instructions to the application or to modify the contents of a standard window.

+ The CPPanel class defines objects that manage the panels of the Cappuccino user interface. A panel is a window that serves an auxiliary function within an application. It generally displays controls that the user can act on to give instructions to the application or to modify the contents of a standard window.

Panels behave differently from standard windows in only a small number of ways, but the ways are important to the user interface:

diff --git a/AppKit/CPPasteboard.j b/AppKit/CPPasteboard.j index 9037b1d8a..42f136e68 100644 --- a/AppKit/CPPasteboard.j +++ b/AppKit/CPPasteboard.j @@ -44,7 +44,7 @@ var CPPasteboards = nil; /*! @class CPPasteboard - CPPasteBoard is the object responsible for cut/copy/paste and drag&drop operations. + CPPasteBoard is the object responsible for cut/copy/paste and drag&drop operations. */ @implementation CPPasteboard : CPObject { diff --git a/AppKit/CPPopUpButton.j b/AppKit/CPPopUpButton.j index 98b9cffd0..32eabce09 100644 --- a/AppKit/CPPopUpButton.j +++ b/AppKit/CPPopUpButton.j @@ -32,7 +32,7 @@ var CPPopUpButtonArrowsImage = nil; /*! @class CPPopUpButton - A CPPopUpButton contains a pop-up menu of items that a user can select from. + A CPPopUpButton contains a pop-up menu of items that a user can select from. */ @implementation CPPopUpButton : CPButton { @@ -228,7 +228,7 @@ var CPPopUpButtonArrowsImage = nil; } /*! - Returns the index of the selected item. If no item is selected, it returns CPNotFound. + Returns the index of the selected item. If no item is selected, it returns CPNotFound. */ - (int)indexOfSelectedItem { @@ -237,7 +237,7 @@ var CPPopUpButtonArrowsImage = nil; // For us, CPNumber is toll-free bridged to Number, so just return the selected index. /*! - Returns the selected item's index. If no item is selected, it returns CPNotFound. + Returns the selected item's index. If no item is selected, it returns CPNotFound. */ - (id)objectValue { @@ -432,7 +432,7 @@ var CPPopUpButtonArrowsImage = nil; // Getting the Indices of Menu Items /*! - Returns the index of the specified item or CPNotFound if the item is not in the list. + Returns the index of the specified item or CPNotFound if the item is not in the list. @param aMenuItem the item to obtain the index for */ - (int)indexOfItem:(CPMenuItem)aMenuItem @@ -441,7 +441,7 @@ var CPPopUpButtonArrowsImage = nil; } /*! - Returns the index of the item with the specified tag or CPNotFound if the item is not in the list. + Returns the index of the item with the specified tag or CPNotFound if the item is not in the list. @param aTag the item's tag */ - (int)indexOfItemWithTag:(int)aTag @@ -450,7 +450,7 @@ var CPPopUpButtonArrowsImage = nil; } /*! - Returns the index of the item with the specified title or CPNotFound. + Returns the index of the item with the specified title or CPNotFound. @param aTitle the item's titel */ - (int)indexOfItemWithTitle:(CPString)aTitle @@ -460,7 +460,7 @@ var CPPopUpButtonArrowsImage = nil; /*! Returns the index of the item with the specified - represented object or CPNotFound + represented object or CPNotFound if a match does not exist. @param anObject the item's represented object */ @@ -471,7 +471,7 @@ var CPPopUpButtonArrowsImage = nil; /*! Returns the index of the item with the specified target - and action. Returns CPNotFound if the no + and action. Returns CPNotFound if the no such item is in the list. @param aTarget the item's target @param anAction the item's action diff --git a/AppKit/CPProgressIndicator.j b/AppKit/CPProgressIndicator.j index ed0cf814b..161fd5f63 100644 --- a/AppKit/CPProgressIndicator.j +++ b/AppKit/CPProgressIndicator.j @@ -376,7 +376,7 @@ var CPProgressIndicatorSpinningStyleColors = nil, /*! Sets whether the indicator should be displayed when it isn't animating. By default this is YES if the style - is CPProgressIndicatorBarStyle, and NO if it's CPProgressIndicatorSpinningStyle. + is CPProgressIndicatorBarStyle, and NO if it's CPProgressIndicatorSpinningStyle. @param isDisplayedWhenStopped YES means the indicator will be displayed when it's not animating. */ - (void)setDisplayedWhenStopped:(BOOL)isDisplayedWhenStopped diff --git a/AppKit/CPResponder.j b/AppKit/CPResponder.j index 6331472fb..c85432ef1 100644 --- a/AppKit/CPResponder.j +++ b/AppKit/CPResponder.j @@ -88,7 +88,7 @@ CPRightArrowKeyCode = 63235; /*! Called to interpret a series of key events. - @param events an array of key CPEvents + @param events an array of key CPEvents */ - (void)interpretKeyEvents:(CPArray)events { diff --git a/AppKit/CPScrollView.j b/AppKit/CPScrollView.j index 729ee16a8..22560e8e8 100644 --- a/AppKit/CPScrollView.j +++ b/AppKit/CPScrollView.j @@ -29,7 +29,7 @@ /*! @class CPScrollView - Used to display views that are too large for the viewing area. the CPScrollView + Used to display views that are too large for the viewing area. the CPScrollView places scroll bars on the side of the view to allow the user to scroll and see the entire contents of the view. */ diff --git a/AppKit/CPScroller.j b/AppKit/CPScroller.j index 12bdb3bc6..33cb9f8db 100644 --- a/AppKit/CPScroller.j +++ b/AppKit/CPScroller.j @@ -211,7 +211,7 @@ var _CPScrollerClassName = nil, // Determining CPScroller Size /*! - Returns the CPScroller's width for a CPRegularControlSize. + Returns the CPScroller's width for a CPRegularControlSize. */ + (float)scrollerWidth { @@ -219,7 +219,7 @@ var _CPScrollerClassName = nil, } /*! - Returns the width of a CPScroller for the specified CPControlSize. + Returns the width of a CPScroller for the specified CPControlSize. @param aControlSize the size of a controller to return the width for */ + (float)scrollerWidthForControlSize:(CPControlSize)aControlSize diff --git a/AppKit/CPSlider.j b/AppKit/CPSlider.j index 08ce3414f..9c5553a76 100644 --- a/AppKit/CPSlider.j +++ b/AppKit/CPSlider.j @@ -30,7 +30,7 @@ var CPSliderHorizontalKnobImage = nil, /*! @class CPSlider - An CPSlider displays, and allows control of, some value in the application. It represents a continuous stream of values of type float, which can be retrieved by the method floatValue and set by the method setFloatValue:. + An CPSlider displays, and allows control of, some value in the application. It represents a continuous stream of values of type float, which can be retrieved by the method floatValue and set by the method setFloatValue:. */ @implementation CPSlider : CPControl { diff --git a/AppKit/CPSplitView.j b/AppKit/CPSplitView.j index 89727ba3b..028d85164 100644 --- a/AppKit/CPSplitView.j +++ b/AppKit/CPSplitView.j @@ -515,7 +515,7 @@ var CPSplitViewDelegateKey = "CPSplitViewDelegateKey", /* Initializes the split view by unarchiving data from aCoder. - @param aCoder the coder containing the archived CPSplitView. + @param aCoder the coder containing the archived CPSplitView. */ - (id)initWithCoder:(CPCoder)aCoder { diff --git a/AppKit/CPTabView.j b/AppKit/CPTabView.j index 3af164570..c918df2ed 100644 --- a/AppKit/CPTabView.j +++ b/AppKit/CPTabView.j @@ -71,11 +71,11 @@ var CPTabViewDidSelectTabViewItemSelector = 1, /*! @class CPTabView - This class represents a view that has multiple subviews (CPTabViewItem) presented as individual tabs. - Only one CPTabViewItem is shown at a time, and other CPTabViewItems can be made visible - (one at a time) by clicking on the CPTabViewItem's tab at the top of the tab view. + This class represents a view that has multiple subviews (CPTabViewItem) presented as individual tabs. + Only one CPTabViewItem is shown at a time, and other CPTabViewItems can be made visible + (one at a time) by clicking on the CPTabViewItem's tab at the top of the tab view. - THe currently selected CPTabViewItem is the view that is displayed. + THe currently selected CPTabViewItem is the view that is displayed. */ @implementation CPTabView : CPView { @@ -222,7 +222,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1, // Adding and Removing Tabs /*! - Adds a CPTabViewItem to the tab view. + Adds a CPTabViewItem to the tab view. @param aTabViewItem the item to add */ - (void)addTabViewItem:(CPTabViewItem)aTabViewItem @@ -231,7 +231,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1, } /*! - Inserts a CPTabViewItem into the tab view + Inserts a CPTabViewItem into the tab view at the specified index. @param aTabViewItem the item to insert @param anIndex the index for the item @@ -274,7 +274,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1, } /*! - Returns the index of the CPTabViewItem with the specified identifier. + Returns the index of the CPTabViewItem with the specified identifier. @param anIdentifier the identifier of the item */ - (int)indexOfTabViewItemWithIdentifier:(CPString)anIdentifier @@ -298,7 +298,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1, } /*! - Returns the CPTabViewItem at the specified index. + Returns the CPTabViewItem at the specified index. */ - (CPTabViewItem)tabViewItemAtIndex:(unsigned)anIndex { diff --git a/AppKit/CPTabViewItem.j b/AppKit/CPTabViewItem.j index b1906576a..fb282deae 100644 --- a/AppKit/CPTabViewItem.j +++ b/AppKit/CPTabViewItem.j @@ -46,8 +46,8 @@ CPPressedTab = 2; /*! @class CPTabView - The class representation of an item in a CPTabView. One tab view item - can be shown at a time in a CPTabView. + The class representation of an item in a CPTabView. One tab view item + can be shown at a time in a CPTabView. */ @implementation CPTabViewItem : CPObject { @@ -60,7 +60,7 @@ CPPressedTab = 2; /*! Initializes the tab view item with the specified identifier. - @return the initialized CPTabViewItem + @return the initialized CPTabViewItem */ - (id)initWithIdentifier:(id)anIdentifier { @@ -74,7 +74,7 @@ CPPressedTab = 2; // Working With Labels /*! - Sets the CPTabViewItem's label. + Sets the CPTabViewItem's label. @param aLabel the label for the item */ - (void)setLabel:(CPString)aLabel @@ -83,7 +83,7 @@ CPPressedTab = 2; } /*! - Returns the CPTabViewItem's label + Returns the CPTabViewItem's label */ - (CPString)label { diff --git a/AppKit/CPTableColumn.j b/AppKit/CPTableColumn.j index 09046f916..2407b4c3a 100644 --- a/AppKit/CPTableColumn.j +++ b/AppKit/CPTableColumn.j @@ -45,9 +45,9 @@ CPTableColumnUserResizingMask = 2; /*! @class CPTableColumn - An CPTableColumn object mainly keeps information about the width of the column, its minimum and maximum width; whether the column can be edited or resized; and the cells used to draw the column header and the data in the column. You can change all these attributes of the column by calling the appropriate methods. Please note that the table column does not hold nor has access to the data to be displayed in the column; this data is maintained in the table view's data source.

+ An CPTableColumn object mainly keeps information about the width of the column, its minimum and maximum width; whether the column can be edited or resized; and the cells used to draw the column header and the data in the column. You can change all these attributes of the column by calling the appropriate methods. Please note that the table column does not hold nor has access to the data to be displayed in the column; this data is maintained in the table view's data source.

-

Each CPTableColumn object is identified by a CPString, called the column identifier. The reason is that, after a column has been added to a table view, the user might move the columns around, so there is a need to identify the columns regardless of its position in the table. +

Each CPTableColumn object is identified by a CPString, called the column identifier. The reason is that, after a column has been added to a table view, the user might move the columns around, so there is a need to identify the columns regardless of its position in the table. @ignore */ diff --git a/AppKit/CPTableView.j b/AppKit/CPTableView.j index 8076b8994..cf4bcd744 100644 --- a/AppKit/CPTableView.j +++ b/AppKit/CPTableView.j @@ -27,7 +27,7 @@ import "CPTableColumn.j" var CPTableViewCellPlaceholder = nil; /* - CPTableView is located within the AppKit framework and is used to display tables. It uses a delegate model for getting its data i.e. you give it an object that provides it with the data it should display. + CPTableView is located within the AppKit framework and is used to display tables. It uses a delegate model for getting its data i.e. you give it an object that provides it with the data it should display. @ignore */ @@ -284,7 +284,7 @@ var CPTableViewCellPlaceholder = nil; } /* - Returns an array containing the table's CPTableColumns. + Returns an array containing the table's CPTableColumns. */ - (CPArray)tableColumns { @@ -323,8 +323,8 @@ var CPTableViewCellPlaceholder = nil; Sets the object that is used to obtain the table data. The data source must implement the following methods:

-- (int)numberOfRowsInTableView:(CPTableView)aTableView
-- (id)tableView:(CPTableView)aTableView objectValueForTableColumn:(CPTableColumn)aTableColumn row:(int)rowIndex
+- (int)numberOfRowsInTableView:(CPTableView)aTableView
+- (id)tableView:(CPTableView)aTableView objectValueForTableColumn:(CPTableColumn)aTableColumn row:(int)rowIndex
 
@param aDataSource the object with the table data @throws CPInternalInconsistencyException if aDataSource doesn't implement all the required methods diff --git a/AppKit/CPToolbar.j b/AppKit/CPToolbar.j index 9d6763fee..2d72bece0 100644 --- a/AppKit/CPToolbar.j +++ b/AppKit/CPToolbar.j @@ -358,7 +358,7 @@ var CPToolbarIdentifierKey = "CPToolbarIdentifierKey", /* Initializes the toolbar by unarchiving data from aCoder. - @param aCoder the coder containing the archived CPToolbar. + @param aCoder the coder containing the archived CPToolbar. */ - (id)initWithCoder:(CPCoder)aCoder { diff --git a/AppKit/CPToolbarItem.j b/AppKit/CPToolbarItem.j index 3929c5682..c56791a9f 100644 --- a/AppKit/CPToolbarItem.j +++ b/AppKit/CPToolbarItem.j @@ -60,7 +60,7 @@ var _CPToolbarSeparatorItemView = nil; /*! @class CPToolbarItem - A representation of an item in a CPToolbar. + A representation of an item in a CPToolbar. */ @implementation CPToolbarItem : CPObject { diff --git a/AppKit/CPView.j b/AppKit/CPView.j index 24e2e8726..50a677535 100644 --- a/AppKit/CPView.j +++ b/AppKit/CPView.j @@ -102,17 +102,17 @@ var DOMElementPrototype = nil, /*! @class CPView - CPView is an abstract class which provides facilities for drawing +

CPView is a class which provides facilities for drawing in a window and receiving events. It is the superclass of many of the visual elements of the GUI.

In order to display itself, a view must be placed in a window (represented by an - CPWindow object). Within the window is a hierarchy of CPViews, + CPWindow object). Within the window is a hierarchy of CPViews, headed by the window's content view. Every other view in a window is a descendant of this view.

Subclasses can override -drawRect: in order to implement their - appearance. Other methods of CPView and CPResponder can + appearance. Other methods of CPView and CPResponder can also be overridden to handle user generated events. */ @implementation CPView : CPResponder @@ -253,7 +253,7 @@ var DOMElementPrototype = nil, /*! Returns an array of all the views contained as direct children of the receiver - @return an array of CPViews + @return an array of CPViews */ - (CPArray)subviews { @@ -270,7 +270,7 @@ var DOMElementPrototype = nil, /*! Makes the argument a subview of the receiver. - @param aSubview the CPView to make a subview + @param aSubview the CPView to make a subview */ - (void)addSubview:(CPView)aSubview { @@ -454,7 +454,7 @@ var DOMElementPrototype = nil, } /*! - Called when the receiver has been moved to a new CPWindow. + Called when the receiver has been moved to a new CPWindow. */ - (void)viewDidMoveToWindow { @@ -524,7 +524,7 @@ var DOMElementPrototype = nil, /*! Sets the frame size of the receiver to the dimensions and origin of the provided rectangle in the coordinate system - of the superview. The method also posts an CPViewFrameDidChangeNotification to the notification + of the superview. The method also posts an CPViewFrameDidChangeNotification to the notification center if the receiver is configured to do so. If the frame is the same as the current frame, the method simply returns (and no notificaion is posted). @param aFrame the rectangle specifying the new origin and size of the receiver @@ -556,7 +556,7 @@ var DOMElementPrototype = nil, /*! Sets the receiver's frame origin to the provided point. The point is defined in the superview's coordinate system. - The method posts a CPViewFrameDidChangeNotification to the default notification center if the receiver + The method posts a CPViewFrameDidChangeNotification to the default notification center if the receiver is configured to do so. If the specified origin is the same as the frame's current origin, the method will simply return (and no notification will be posted). @param aPoint the new origin point @@ -581,7 +581,7 @@ var DOMElementPrototype = nil, /*! Sets the receiver's frame size. If aSize is the same as the frame's current dimensions, this - method simply returns. The method posts a CPViewFrameDidChangeNotification to the + method simply returns. The method posts a CPViewFrameDidChangeNotification to the default notification center if the receiver is configured to do so. @param aSize the new size for the frame */ @@ -654,7 +654,7 @@ var DOMElementPrototype = nil, /*! Sets the receiver's bounds. The bounds define the size and location of the receiver inside it's frame. Posts a - CPViewBoundsDidChangeNotification to the default notification center if the receiver is configured to do so. + CPViewBoundsDidChangeNotification to the default notification center if the receiver is configured to do so. @param bounds the new bounds */ - (void)setBounds:(CGRect)bounds @@ -684,7 +684,7 @@ var DOMElementPrototype = nil, /*! Sets the location of the receiver inside its frame. The method - posts a CPViewBoundsDidChangeNotification to the + posts a CPViewBoundsDidChangeNotification to the default notification center if the receiver is configured to do so. @param aPoint the new location for the receiver */ @@ -727,7 +727,7 @@ var DOMElementPrototype = nil, /*! Sets the receiver's size inside its frame. The method posts a - CPViewBoundsDidChangeNotification to the default + CPViewBoundsDidChangeNotification to the default notification center if the receiver is configured to do so. @param aSize the new size for the receiver */ @@ -1236,7 +1236,7 @@ var DOMElementPrototype = nil, } /*! - Sets whether the receiver posts a CPViewFrameDidChangeNotification notification + Sets whether the receiver posts a CPViewFrameDidChangeNotification notification to the default notification center when its frame is changed. The default is NO. Methods that could cause a frame change notification are:

@@ -1259,7 +1259,7 @@ setFrameOrigin:
 }
 
 /*!
-    Returns YES if the receiver posts a CPViewFrameDidChangeNotification if its frame is changed.
+    Returns YES if the receiver posts a CPViewFrameDidChangeNotification if its frame is changed.
 */
 - (BOOL)postsFrameChangedNotifications
 {
@@ -1267,7 +1267,7 @@ setFrameOrigin:
 }
 
 /*!
-    Sets whether the receiver posts a CPViewBoundsDidChangeNotification notification
+    Sets whether the receiver posts a CPViewBoundsDidChangeNotification notification
     to the default notification center when its bounds is changed. The default is NO.
     Methods that could cause a bounds change notification are:
 
@@ -1291,7 +1291,7 @@ setBoundsOrigin:
 
 /*!
     Returns YES if the receiver posts a
-    CPViewBoundsDidChangeNotification when its
+    CPViewBoundsDidChangeNotification when its
     bounds is changed.
 */
 - (BOOL)postsBoundsChangedNotifications
@@ -1331,7 +1331,7 @@ setBoundsOrigin:
 
 /*!
     Sets the receiver's list of acceptable data types for a dragging operation.
-    @param pasteboardTypes an array of CPPasteboards
+    @param pasteboardTypes an array of CPPasteboards
 */
 - (void)registerForDraggedTypes:(CPArray)pasteboardTypes
 {
@@ -1340,7 +1340,7 @@ setBoundsOrigin:
 
 /*!
     Returns an array of all types the receiver accepts for dragging operations.
-    @return an array of CPPasteBoards
+    @return an array of CPPasteBoards
 */
 - (CPArray)registeredDraggedTypes
 {
@@ -1559,7 +1559,7 @@ setBoundsOrigin:
 }
 
 /*!
-    Scrolls the nearest ancestor CPClipView a minimum amount so aRect can become visible.
+    Scrolls the nearest ancestor CPClipView a minimum amount so aRect can become visible.
     @param aRect the area to become visible
     @return  if any scrolling occurred, NO otherwise.
 */
@@ -1627,8 +1627,8 @@ setBoundsOrigin:
 }
 
 /*!
-    Returns the CPScrollView containing the receiver.
-    @return the CPScrollView containing the receiver.
+    Returns the CPScrollView containing the receiver.
+    @return the CPScrollView containing the receiver.
 */
 - (CPScrollView)enclosingScrollView
 {
@@ -1652,7 +1652,7 @@ setBoundsOrigin:
 }
 
 /*!
-    Notifies the receiver (superview of a CPClipView)
+    Notifies the receiver (superview of a CPClipView)
     that the clip view bounds or the document view bounds have changed.
     @param aClipView the clip view of the superview being notified
 */
@@ -1714,8 +1714,8 @@ setBoundsOrigin:
 }
 
 /*!
-    Returns YES if the receiver uses a CALayer
-    @returns YES if the receiver uses a CALayer
+    Returns YES if the receiver uses a CALayer
+    @returns YES if the receiver uses a CALayer
 */
 - (BOOL)wantsLayer
 {
diff --git a/AppKit/CPWindow.j b/AppKit/CPWindow.j
index 8c7aa7637..aec1dc6da 100644
--- a/AppKit/CPWindow.j
+++ b/AppKit/CPWindow.j
@@ -186,7 +186,7 @@ var CPWindowSaveImage       = nil,
 
 /*! @class CPWindow
 
-    An CPWindow instance represents a window, panel or menu on the screen.

+ An CPWindow instance represents a window, panel or menu on the screen.

Each window has a style, which determines how the window is decorated; whether it has a border, a title bar, a resize bar, minimise and close buttons.

@@ -194,7 +194,7 @@ var CPWindowSaveImage = nil,

A window always contains a content view which is the highest level view available for public (application) use. This view fills the area of the window inside any decoration/border. This is the only part of the window that application programmers are allowed to draw in directly.

-

You can convert between view coordinates and window base coordinates using the [CPView -convertPoint:fromView:], [CPView -convertPoint:toView:], [CPView -convertRect:fromView:], and [CPView -convertRect:toView:] methods with a nil view argument. +

You can convert between view coordinates and window base coordinates using the [CPView -convertPoint:fromView:], [CPView -convertPoint:toView:], [CPView -convertRect:fromView:], and [CPView -convertRect:toView:] methods with a nil view argument. @par Delegate Methods @@ -876,7 +876,7 @@ CPTexturedBackgroundWindowMask /*! Sets the delegate for the window. Passing nil will just remove the window's current delegate. - @param aDelegate an object to respond to the various delegate methods of CPWindow + @param aDelegate an object to respond to the various delegate methods of CPWindow */ - (void)setDelegate:(id)aDelegate { @@ -1079,7 +1079,7 @@ CPTexturedBackgroundWindowMask } /*! - Dispatches events that are sent to it from CPApplication. + Dispatches events that are sent to it from CPApplication. @param anEvent the event to be dispatched */ - (void)sendEvent:(CPEvent)anEvent diff --git a/AppKit/CPWindowController.j b/AppKit/CPWindowController.j index fe7db2f2c..9bf09717b 100644 --- a/AppKit/CPWindowController.j +++ b/AppKit/CPWindowController.j @@ -32,10 +32,10 @@ /*! @class CPWindowController - An instance of a CPWindowController manages a CPWindow. It has methods + An instance of a CPWindowController manages a CPWindow. It has methods that get called when the window is loading, and after the window has loaded. In the - Model-View-Controller method of program design, the CPWindowController would be - considered the 'Controller' and the CPWindow the 'Model.' + Model-View-Controller method of program design, the CPWindowController would be + considered the 'Controller' and the CPWindow the 'Model.' */ @implementation CPWindowController : CPResponder { @@ -123,7 +123,7 @@ /*! Returns YES if the window has been loaded. Specifically, - if loadWindow has been called. + if loadWindow has been called. */ - (BOOL)isWindowLoaded { diff --git a/AppKit/CoreAnimation/CAAnimation.j b/AppKit/CoreAnimation/CAAnimation.j index d94804b7f..fbaca60fd 100644 --- a/AppKit/CoreAnimation/CAAnimation.j +++ b/AppKit/CoreAnimation/CAAnimation.j @@ -34,8 +34,8 @@ } /*! - Creates a new CAAnimation instance - @return a new CAAnimation instance + Creates a new CAAnimation instance + @return a new CAAnimation instance */ + (id)animation { @@ -191,8 +191,8 @@ @end /*! - A CABasicAnimation is a simple animation that moves a - CALayer from one point to another over a specified + A CABasicAnimation is a simple animation that moves a + CALayer from one point to another over a specified period of time. */ @implementation CABasicAnimation : CAPropertyAnimation diff --git a/AppKit/CoreAnimation/CALayer.j b/AppKit/CoreAnimation/CALayer.j index 583ad8ccc..baef5f944 100644 --- a/AppKit/CoreAnimation/CALayer.j +++ b/AppKit/CoreAnimation/CALayer.j @@ -51,11 +51,11 @@ var CALayerRegisteredRunLoopUpdates = nil; /*! @class CALayer - A CALayer is similar to a CPView, but with the ability + A CALayer is similar to a CPView, but with the ability to have a transform applied to it. @delegate -(void)drawLayer:(CALayer)layer inContext:(CGContextRef)ctx; - If the delegate implements this method, the CALayer will + If the delegate implements this method, the CALayer will call this in place of its drawInContext:. @param layer the layer to draw for @param ctx the context to draw on @@ -418,7 +418,7 @@ var CALayerRegisteredRunLoopUpdates = nil; // Providing Layer Content /*! - Returns the CGImage contents of this layer. + Returns the CGImage contents of this layer. The default contents are nil. */ - (CGImage)contents diff --git a/AppKit/CoreGraphics/CGColor.j b/AppKit/CoreGraphics/CGColor.j index fd48edb6f..6c9381041 100644 --- a/AppKit/CoreGraphics/CGColor.j +++ b/AppKit/CoreGraphics/CGColor.j @@ -62,8 +62,8 @@ function CGColorRelease() } /*! - Creates a new CGColor. - @param aColorSpace the CGColorSpace of the color + Creates a new CGColor. + @param aColorSpace the CGColorSpace of the color @param components the color's intensity values plus alpha @return CGColor the new color object @group CGColor @@ -86,10 +86,10 @@ function CGColorCreate(aColorSpace, components) } /*! - Creates a copy of a color... but not really. CGColors + Creates a copy of a color... but not really. CGColors are immutable, so to be efficient, this function will just return the same object that was passed in. - @param aColor the CGColor to 'copy' + @param aColor the CGColor to 'copy' @return CGColor the color copy @group CGColor */ @@ -166,7 +166,7 @@ function CGColorCreateCopyWithAlpha(aColor, anAlpha) /*! Creates a color using the specified pattern. - @param aColorSpace the CGColorSpace + @param aColorSpace the CGColorSpace @param aPattern the pattern image @param components the color components plus the alpha component @return CGColor the patterned color @@ -182,8 +182,8 @@ function CGColorCreateWithPattern(aColorSpace, aPattern, components) /*! Determines if two colors are the same. - @param lhs the first CGColor - @param rhs the second CGColor + @param lhs the first CGColor + @param rhs the second CGColor @return YES if the two colors are equal. NO otherwise. */ @@ -229,8 +229,8 @@ function CGColorGetAlpha(aColor) } /*! - Returns the CGColor's color space. - @return CGColorSpace + Returns the CGColor's color space. + @return CGColorSpace @group CGColor */ function CGColorGetColorSpace(aColor) @@ -239,7 +239,7 @@ function CGColorGetColorSpace(aColor) } /*! - Returns the CGColor's components + Returns the CGColor's components including the alpha in an array. @param aColor the color @return CPArray the color's components @@ -252,7 +252,7 @@ function CGColorGetComponents(aColor) /*! Returns the number of color components (including alpha) in the specified color. - @param aColor the CGColor + @param aColor the CGColor @return CPNumber the number of components @group CGColor */ @@ -262,8 +262,8 @@ function CGColorGetNumberOfComponents(aColor) } /*! - Gets the CGColor's pattern. - @param a CGColor + Gets the CGColor's pattern. + @param a CGColor @return CGPatternFIXME the pattern image @group CGColor */ diff --git a/AppKit/CoreGraphics/CGGeometry.j b/AppKit/CoreGraphics/CGGeometry.j index 9f156cec8..d9a07af7a 100644 --- a/AppKit/CoreGraphics/CGGeometry.j +++ b/AppKit/CoreGraphics/CGGeometry.j @@ -66,11 +66,11 @@ _function(CGRectIsNull(aRect)) _function(CGRectContainsPoint(aRect, aPoint)) /*! - Returns a BOOL indicating whether CGRect lhsRect - contains CGRect rhsRect. + Returns a BOOL indicating whether CGRect lhsRect + contains CGRect rhsRect. @group CGRect - @param lhsRect the CGRect to test if rhsRect is inside of - @param rhsRect the CGRect to test if it fits inside lhsRect. + @param lhsRect the CGRect to test if rhsRect is inside of + @param rhsRect the CGRect to test if it fits inside lhsRect. @return BOOL YES if rhsRect fits inside lhsRect. */ function CGRectContainsRect(lhsRect, rhsRect) @@ -83,8 +83,8 @@ function CGRectContainsRect(lhsRect, rhsRect) /*! Returns YES if the two rectangles intersect @group CGRect - @param lhsRect the first CGRect - @param rhsRect the second CGRect + @param lhsRect the first CGRect + @param rhsRect the second CGRect @return BOOL YES if the two rectangles have any common spaces, and NO, otherwise. */ function CGRectIntersectsRect(lhsRect, rhsRect) @@ -95,8 +95,8 @@ function CGRectIntersectsRect(lhsRect, rhsRect) } /*! - Makes the origin and size of a CGRect all integers. Specifically, by making - the southwest corner the origin (rounded down), and the northeast corner a CGSize (rounded up). + Makes the origin and size of a CGRect all integers. Specifically, by making + the southwest corner the origin (rounded down), and the northeast corner a CGSize (rounded up). @param aRect the rectangle to operate on @return CGRect the modified rectangle (same as the input) @group CGRect diff --git a/Objective-J/bootstrap.js b/Objective-J/bootstrap.js index d0577d74c..42d4767e6 100644 --- a/Objective-J/bootstrap.js +++ b/Objective-J/bootstrap.js @@ -21,4 +21,4 @@ */ if (window.OBJJ_MAIN_FILE) - objj_import("main.j", YES, function() { main(); }); + objj_import(OBJJ_MAIN_FILE, YES, function() { main(); }); diff --git a/Tools/Documentation/Cappuccino.doxygen b/Tools/Documentation/Cappuccino.doxygen index a73f5bdc6..d083ca453 100644 --- a/Tools/Documentation/Cappuccino.doxygen +++ b/Tools/Documentation/Cappuccino.doxygen @@ -5,7 +5,7 @@ #--------------------------------------------------------------------------- DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = Cappuccino -PROJECT_NUMBER = 1.5.5 +PROJECT_NUMBER = 0.6 OUTPUT_DIRECTORY = Documentation CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English diff --git a/Tools/READMEs/STARTER-README b/Tools/READMEs/STARTER-README index 551b8c326..fe0b77486 100644 --- a/Tools/READMEs/STARTER-README +++ b/Tools/READMEs/STARTER-README @@ -2,11 +2,11 @@ Welcome to the Cappuccino Starter Package! Included you should find the following: -1. Frameworks +1. Documentation 2. NewApplication 3. README -NewApplication is a stand alone Cappuccino application that you can use as a template to start building your own apps. To get started, just open up NewApplication/index.html in your favorite web browser. A great place to go from there is to read the "Downloading and Getting Started" tutorial found at http://cappuccino.org/learn/tutorials/starter-tutorial.php. This will walk you through these initial steps as well as getting you to do a little coding. +NewApplication is a stand alone Cappuccino application that you can use as a template to start building your own apps. To get started, just open up NewApplication/index.html in your favorite web browser. A great place to go from there is to read the "Downloading and Getting Started" tutorial found at http://cappuccino.org/learn/tutorials/starter-tutorial.php. This will walk you through these initial steps as well as getting you to do a little coding. If you want to debug your application, try running it with index-debug.html instead, which should make it easier. You can build your entire application right from this sample project, but if you want to dig a little deeper, you can also download the Tools package found at http://cappuccino.org/download/. This will set you up with some great additions like syntax modules for certain text editors and build tools to get extra performance. diff --git a/Tools/READMEs/TOOLS-README b/Tools/READMEs/TOOLS-README index b22681926..efac4c0ba 100644 --- a/Tools/READMEs/TOOLS-README +++ b/Tools/READMEs/TOOLS-README @@ -6,11 +6,13 @@ This package includes syntax highlighting modes for both SubEthaEdit, Coda, Text + SubEthaEdit + - NOTE: SubEthaEdit now has built-in support for Objective-J, but the copy included here is probably more up to date. - Unarchive Tools/Editors/Objective-J.mode.zip - Double click the generated Objective-J.mode file + Coda + - NOTE: Coda now has built-in support for Objective-J, but the copy included here is probably more up to date. - Unarchive Tools/Editors/Objective-J.mode.zip - Place the generated Objective-J.mode file in ~/Library/Application Support/Coda/Modes @@ -87,6 +89,6 @@ objjc is a static preinterpreter for Objectie-J. It will take Objective-J files Steam is a simple tool for managing Objective-J projects. Among other things, it allows you to statically pre-interpret entire Objective-J applications so that you can deliver it without requiring client-side pre-interpretation. - steam create path - This will create a new Cappuccino application at the specified path. The resulting project contains a basic Cappuccino application as well as Objective-J and the preprocessed Cappuccino frameworks. + steam create [-l] path - This will create a new Cappuccino application at the specified path. The resulting project contains a basic Cappuccino application as well as Objective-J and the preprocessed Cappuccino frameworks. steam build [options] - This builds an application or framework. \ No newline at end of file diff --git a/build.xml b/build.xml index 0f4441277..6953f8f64 100644 --- a/build.xml +++ b/build.xml @@ -85,13 +85,45 @@ - + + + + + + + + + + + + + + + + + + *** WARNING: Doxygen not installed. Could not create documentation. + + + + - - + + + + + + + + + + + + + @@ -269,7 +301,10 @@ - + + + +