Skip to content

Commit

Permalink
Cleaned up old deprecated documentation stuff and added documentation…
Browse files Browse the repository at this point in the history
… to deploy.

Reviewed by me.
  • Loading branch information
Francisco Ryan Tolmasky I committed Dec 10, 2008
1 parent b87493b commit d92fc8c
Show file tree
Hide file tree
Showing 47 changed files with 255 additions and 218 deletions.
2 changes: 1 addition & 1 deletion AppKit/CPAnimation.j
Expand Up @@ -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 <objj>CPAnimation</objj>'s
The value from this method will be returned when CPAnimation's
<code>currentValue</code> method is called.
@param animation the animation to obtain the curve value for
@param progress the current animation progress
Expand Down
8 changes: 4 additions & 4 deletions AppKit/CPApplication.j
Expand Up @@ -230,7 +230,7 @@ CPRunContinuesResponse = -1002;
/*!
This method is called by <code>run</code> before the event loop begins.
When it successfully completes, it posts the notification
<objj>CPApplicationDidFinishLaunchingNotification</objj>. If you override
CPApplicationDidFinishLaunchingNotification. If you override
<code>finishLaunching</code>, the subclass method should invoke the superclass method.
*/
- (void)finishLaunching
Expand Down Expand Up @@ -437,15 +437,15 @@ CPRunContinuesResponse = -1002;
}

/*!
Returns the <objj>CPWindow</objj> object corresponding to <code>aWindowNumber</code>.
Returns the CPWindow object corresponding to <code>aWindowNumber</code>.
*/
- (CPWindow)windowWithWindowNumber:(int)aWindowNumber
{
return _windows[aWindowNumber];
}

/*!
Returns an array of the application's <objj>CPWindow</objj>s
Returns an array of the application's CPWindows
*/
- (CPArray)windows
{
Expand Down Expand Up @@ -599,7 +599,7 @@ CPRunContinuesResponse = -1002;
<ol>
<li>a responder from the key window</li>
<li>a responder frmo the main window</li>
<li>the <objj>CPApplication</objj> instance</li>
<li>the CPApplication instance</li>
<li>the application delegate</li>
<li>the document controller</li>
</ol>
Expand Down
8 changes: 4 additions & 4 deletions AppKit/CPButton.j
Expand Up @@ -222,7 +222,7 @@ var _CPButtonClassName = nil,

/*! @class CPButton
<objj>CPButton</objj> is a subclass of <objj>CPControl</objj> 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.
*/
Expand Down Expand Up @@ -252,7 +252,7 @@ var _CPButtonClassName = nil,
}

/*!
Initializes the <objj>CPButton</objj> class.
Initializes the CPButton class.
@ignore
*/
+ (void)initialize
Expand Down Expand Up @@ -437,7 +437,7 @@ var _CPButtonClassName = nil,

/*!
Sets the button's state to <code>aState</code>.
@param aState Possible states are any of the <objj>CPButton</objj> globals:
@param aState Possible states are any of the CPButton globals:
<code>CPOffState, CPOnState, CPMixedState</code>
*/
- (void)setState:(int)aState
Expand Down Expand Up @@ -830,7 +830,7 @@ var CPButtonImageKey = @"CPButtonImageKey",

/*!
Initializes the button by unarchiving data from <code>aCoder</code>.
@param aCoder the coder containing the archived <objj>CPButton</objj>.
@param aCoder the coder containing the archived CPButton.
*/
- (id)initWithCoder:(CPCoder)aCoder
{
Expand Down
8 changes: 4 additions & 4 deletions AppKit/CPClipView.j
Expand Up @@ -27,8 +27,8 @@

/*! @class CPClipView
<objj>CPClipView</objj> 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 <objj>CPScrollView</objj>.
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
{
Expand Down Expand Up @@ -134,7 +134,7 @@
}

/*!
Handles a <objj>CPViewBoundsDidChangeNotification</objj>.
Handles a CPViewBoundsDidChangeNotification.
@param aNotification the notification event
*/
- (void)viewBoundsChanged:(CPNotification)aNotification
Expand All @@ -143,7 +143,7 @@
}

/*!
Handles a <objj>CPViewFrameDidChangeNotification</objj>.
Handles a CPViewFrameDidChangeNotification.
@param aNotification the notification event
*/
- (void)viewFrameChanged:(CPNotification)aNotification
Expand Down
4 changes: 2 additions & 2 deletions AppKit/CPCollectionView.j
Expand Up @@ -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 (<objj>CPString</objj>)
@return an array of drag types (CPString)
*/
@implementation CPCollectionView : CPView
{
Expand Down Expand Up @@ -567,7 +567,7 @@
@end

/*!
Represents an object inside a <objj>CPCollectionView</objj>.
Represents an object inside a CPCollectionView.
*/
@implementation CPCollectionViewItem : CPObject
{
Expand Down
6 changes: 3 additions & 3 deletions AppKit/CPColor.j
Expand Up @@ -48,7 +48,7 @@ var _hueComponent = 0,
<p>The class does not have a <code>set:</code> method
like NextStep based frameworks to change the color of
the current context. To change the color of the current
context, use <objj>CGContextSetFillColor()</objj>.
context, use CGContextSetFillColor().
*/
@implementation CPColor : CPObject
{
Expand Down Expand Up @@ -227,7 +227,7 @@ var _hueComponent = 0,
}

/*!
Creates a <objj>CPColor</objj> 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
Expand Down Expand Up @@ -511,7 +511,7 @@ var CPColorComponentsKey = @"CPColorComponentsKey",
var hexCharacters = "0123456789ABCDEF";

/*!
Used for the <objj>CPColor</objj> <code>colorWithHexString:</code> implementation
Used for the CPColor <code>colorWithHexString:</code> implementation
@ignore
@class CPColor
@return an array of rgb components
Expand Down
2 changes: 1 addition & 1 deletion AppKit/CPColorPicker.j
Expand Up @@ -25,7 +25,7 @@

/*! @class CPColorPicker
<objj>CPColorPicker</objj> is an abstract superclass for all color picker subclasses. If you want a particular color picker, use <objj>CPColorPanel</objj>'s <code>setPickerMode:</code> 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 <code>setPickerMode:</code> method. The simplest way to implement your own color picker is to create a subclass of CPColorPicker.
*/
@implementation CPColorPicker : CPObject
{
Expand Down
8 changes: 4 additions & 4 deletions AppKit/CPColorWell.j
Expand Up @@ -31,9 +31,9 @@ var _CPColorWellDidBecomeExclusiveNotification = @"_CPColorWellDidBecomeExclusiv

/*! @class CPColorWell
<objj>CPColorWell</objj> is a <objj>CPControl</objj> for selecting and displaying a single color value. An example of a <objj>CPColorWell</objj> object (or simply color well) is found in <objj>CPColorPanel</objj>, which uses a color well to display the current color selection.</p>
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.</p>
<p>An application can have one or more active <objj>CPColorWell</objj>s. You can activate multiple <objj>CPColorWell</objj>s by invoking the <code>activate:</code> method with <code>NO</code> as its argument. When a mouse-down event occurs on an <objj>CPColorWell</objj>'s border, it becomes the only active color well. When a color well becomes active, it brings up the color panel also.
<p>An application can have one or more active CPColorWells. You can activate multiple CPColorWells by invoking the <code>activate:</code> method with <code>NO</code> 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
{
Expand Down Expand Up @@ -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 <code>YES</code>, deactivates any other <objj>CPColorWell</objj>s. <code>NO</code>, keeps them active.
If exclusive is <code>YES</code>, deactivates any other CPColorWells. <code>NO</code>, keeps them active.
@param shouldBeExclusive whether other color wells should be deactivated.
*/
- (void)activate:(BOOL)shouldBeExclusive
Expand Down Expand Up @@ -262,7 +262,7 @@ var CPColorWellColorKey = "CPColorWellColorKey",

/*!
Initializes the color well by unarchiving data from <code>aCoder</code>.
@param aCoder the coder containing the archived <objj>CPColorWell</objj>.
@param aCoder the coder containing the archived CPColorWell.
*/
- (id)initWithCoder:(CPCoder)aCoder
{
Expand Down
2 changes: 1 addition & 1 deletion AppKit/CPControl.j
Expand Up @@ -82,7 +82,7 @@ var CPControlBlackColor = [CPColor blackColor];

/*! @class CPControl
<objj>CPControl</objj> is an abstract superclass used to implement user interface elements. As a subclass of <objj>CPView</objj> and <objj>CPResponder</objj> 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
{
Expand Down
2 changes: 1 addition & 1 deletion AppKit/CPCookie.j
Expand Up @@ -25,7 +25,7 @@


/*! @class CPCookie
<objj>CPCookie</objj> 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
{
Expand Down
10 changes: 5 additions & 5 deletions AppKit/CPDocument.j
Expand Up @@ -82,10 +82,10 @@ var CPDocumentUntitledCount = 0;

/*! @class CPDocument
<objj>CPDocument</objj> 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
<objj>CPDocument</objj>s should be used to represent this.
CPDocuments should be used to represent this.
*/
@implementation CPDocument : CPResponder
{
Expand Down Expand Up @@ -543,15 +543,15 @@ var CPDocumentUntitledCount = 0;
// Working with Undo Manager
/*!
Returns <code>YES</code> if the document has a
<objj>CPUndoManager</objj>.
CPUndoManager.
*/
- (BOOL)hasUndoManager
{
return _hasUndoManager;
}

/*!
Sets whether the document should have a <objj>CPUndoManager</objj>.
Sets whether the document should have a CPUndoManager.
@param aFlag <code>YES</code> makes the document have an undo manager
*/
- (void)setHasUndoManager:(BOOL)aFlag
Expand Down Expand Up @@ -649,7 +649,7 @@ var CPDocumentUntitledCount = 0;
}

/*
Implemented as a delegate of a <objj>CPWindow</objj>
Implemented as a delegate of a CPWindow
@ignore
*/
- (CPUndoManager)windowWillReturnUndoManager:(CPWindow)aWindow
Expand Down
4 changes: 2 additions & 2 deletions AppKit/CPDocumentController.j
Expand Up @@ -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 <objj>CPDocumentController</objj>
@return a CPDocumentController
*/
+ (id)sharedDocumentController
{
Expand Down Expand Up @@ -294,7 +294,7 @@ var CPSharedDocumentController = nil;
}

/*!
Returns the <objj>CPDocument</objj> subclass associated with <code>aType</code>.
Returns the CPDocument subclass associated with <code>aType</code>.
@param aType the type of document
@return a Cappuccino Class object, or <code>nil</code> if no match was found
*/
Expand Down
2 changes: 1 addition & 1 deletion AppKit/CPDragServer.j
Expand Up @@ -116,7 +116,7 @@ var CPDragServerUpdateDragging = function(anEvent)
}

/*
<objj>CPDraggingInfo</objj> 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
Expand Down
22 changes: 11 additions & 11 deletions AppKit/CPEvent.j
Expand Up @@ -180,7 +180,7 @@ var _CPEventPeriodicEventPeriod = 0,
_CPEventPeriodicEventTimer = nil;

/*! @class CPEvent
<objj>CPEvent</objj> encapsulates the details of a Cappuccino keyboard or mouse event.
CPEvent encapsulates the details of a Cappuccino keyboard or mouse event.
*/
@implementation CPEvent : CPObject
{
Expand All @@ -206,18 +206,18 @@ var _CPEventPeriodicEventPeriod = 0,

/*!
Creates a new keyboard event.
@param anEventType the event type. Must be one of <objj>CPKeyDown</objj>, <objj>CPKeyUp</objj> or <objj>CPFlagsChanged</objj>
@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 <code>aWindowNumber</code>
@param modifierFlags a bitwise combination of the modifiers specified in the <objj>CPEvent</objj> 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 <objj>CPWindow</objj> 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 <code>YES</code> 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 <code>anEventType</code> is not a <objj>CPKeyDown</objj>,
<objj>CPKeyUp</objj> or <objj>CPFlagsChanged</objj>
@throws CPInternalInconsistencyException if <code>anEventType</code> is not a CPKeyDown,
CPKeyUp or CPFlagsChanged
@return the keyboard event
*/
+ (CPEvent)keyEventWithType:(CPEventType)anEventType location:(CGPoint)aPoint modifierFlags:(unsigned int)modifierFlags
Expand All @@ -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 <code>aWindowNumber</code>
@param modifierFlags a bitwise combination of the modifiers specified in the <objj>CPEvent</objj> 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 <objj>CPWindow</objj> 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
Expand All @@ -253,11 +253,11 @@ var _CPEventPeriodicEventPeriod = 0,

/*!
Creates a new custom event
@param anEventType the event type. Must be one of <objj>CPAppKitDefined</objj>, <objj>CPSystemDefined</objj>, <objj>CPApplicationDefined</objj> or <objj>CPPeriodic</objj>
@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 <code>aWindowNumber</code>
@param modifierFlags a bitwise combination of the modifiers specified in the <objj>CPEvent</objj> 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 <objj>CPWindow</objj> 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
Expand Down
2 changes: 1 addition & 1 deletion AppKit/CPFont.j
Expand Up @@ -27,7 +27,7 @@ var _CPFonts = {};

/*! @class CPFont
The <objj>CPFont</objj> 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 <objj>CPFont</objj>.
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
{
Expand Down

0 comments on commit d92fc8c

Please sign in to comment.