@@ -62,12 +62,12 @@ var CPAlertWarningImage, CPAlert is an alert panel that can be displayed modally to present the user with a message and one or more options. - It can be used to display an information message (<pre>CPInformationalAlertStyle</pre>), - a warning message (<pre>CPWarningAlertStyle</pre> - which is the default), or a critical - alert (<pre>CPCriticalAlertStyle</pre>). In each case the user can be presented with one - or more options by adding buttons using the <pre>addButtonWithTitle:</pre> method. + It can be used to display an information message \c CPInformationalAlertStyle, + a warning message \c CPWarningAlertStyle (the default), or a critical + alert \c CPCriticalAlertStyle. In each case the user can be presented with one + or more options by adding buttons using the \c -addButtonWithTitle: method. - The panel is displayed modally by calling <pre>runModal</pre> and once the user has + The panel is displayed modally by calling \c -runModal and once the user has dismissed the panel, a message will be sent to the panel's delegate (if set), informing it which button was clicked (see delegate methods). @@ -112,7 +112,7 @@ var CPAlertWarningImage, } /*! - Initializes a <pre>CPAlert</pre> panel with the default alert style (<pre>CPWarningAlertStyle</pre>). + Initializes a \c CPAlert panel with the default alert style \c CPWarningAlertStyle. */ - (id)init { @@ -244,7 +244,7 @@ var CPAlertWarningImage, /*! Adds a button with a given title to the receiver. - Buttons will be added starting from the right hand side of the <pre>CPAlert</pre> panel. + Buttons will be added starting from the right hand side of the \c CPAlert panel. The first button will have the index 0, the second button 1 and so on. You really shouldn't need more than 3 buttons. @@ -269,7 +269,7 @@ var CPAlertWarningImage, } /*! - Displays the <pre>CPAlert</pre> panel as a modal dialog. The user will not be + Displays the \c CPAlert panel as a modal dialog. The user will not be able to interact with any other controls until s/he has dismissed the alert by clicking on one of the buttons. */ AppKit/CPAlert.j @@ -57,10 +57,10 @@ ACTUAL_FRAME_RATE = 0; @par Delegate Methods @delegate -(BOOL)animationShouldStart:(CPAnimation)animation; - Called at the beginning of <code>startAnimation</code>. + Called at the beginning of \c -startAnimation. @param animation the animation that will start - @return <code>YES</code> allows the animation to start. - <code>NO</code> stops the animation. + @return \c YES allows the animation to start. + \c NO stops the animation. @delegate -(void)animationDidEnd:(CPAnimation)animation; Called when an animation has completed. @@ -72,7 +72,7 @@ ACTUAL_FRAME_RATE = 0; @delegate - (float)animation:(CPAnimation)animation valueForProgress:(float)progress; The value from this method will be returned when CPAnimation's - <code>currentValue</code> method is called. + \c currentValue method is called. @param animation the animation to obtain the curve value for @param progress the current animation progress @return the curve value @@ -154,7 +154,7 @@ ACTUAL_FRAME_RATE = 0; /*! Sets the animation's length. @param aDuration the new animation length - @throws CPInvalidArgumentException if <code>aDuration</code> is negative + @throws CPInvalidArgumentException if \c aDuration is negative */ - (void)setDuration:(CPTimeInterval)aDuration { @@ -175,7 +175,7 @@ ACTUAL_FRAME_RATE = 0; /*! Sets the animation frame rate. This is not a guaranteed frame rate. 0 means to go as fast as possible. @param frameRate the new desired frame rate - @throws CPInvalidArgumentException if <code>frameRate</code> is negative + @throws CPInvalidArgumentException if \c frameRate is negative */ - (void)setFrameRate:(float)frameRate { @@ -211,7 +211,7 @@ ACTUAL_FRAME_RATE = 0; } /*! - Starts the animation. The method calls <code>animationShouldStart:</code> + Starts the animation. The method calls \c -animationShouldStart: on the delegate (if it implements it) to see if the animation should begin. */ @@ -270,7 +270,7 @@ ACTUAL_FRAME_RATE = 0; } /*! - Returns <code>YES</code> if the animation + Returns \c YES if the animation is running. */ - (BOOL)isAnimating AppKit/CPAnimation.j @@ -51,7 +51,7 @@ CPRunContinuesResponse = -1002; CPApplication is THE way to start up the Cappucino framework for your application to use. Every GUI application has exactly one instance of CPApplication (or of a custom subclass of CPApplication). Your program's main() function can create that instance by calling the - <code>CPApplicationMain</code> function. A simple example looks like this: + \c CPApplicationMain function. A simple example looks like this: <pre> function main(args, namedArgs) @@ -107,7 +107,7 @@ CPRunContinuesResponse = -1002; /*! Initializes the Document based application with basic menu functions. - Functions are <code>New, Open, Undo, Redo, Save, Cut, Copy, Paste</code>. + Functions are \c New, \c Open, \c Undo, \c Redo, \c Save, \c Cut, \c Copy, \c Paste. @return the initialized application */ - (id)init @@ -237,10 +237,10 @@ CPRunContinuesResponse = -1002; } /*! - This method is called by <code>run</code> before the event loop begins. + This method is called by \c -run before the event loop begins. When it successfully completes, it posts the notification CPApplicationDidFinishLaunchingNotification. If you override - <code>finishLaunching</code>, the subclass method should invoke the superclass method. + \c -finishLaunching, the subclass method should invoke the superclass method. */ - (void)finishLaunching { @@ -280,7 +280,7 @@ CPRunContinuesResponse = -1002; } /*! - Calls <code>finishLaunching</code> method which results in starting + Calls \c -finishLaunching method which results in starting the main event loop. */ - (void)run @@ -290,7 +290,7 @@ CPRunContinuesResponse = -1002; // Managing the Event Loop /*! - Starts a modal event loop for <code>aWindow</code> + Starts a modal event loop for \c aWindow @param aWindow the window to start the event loop for */ - (void)runModalForWindow:(CPWindow)aWindow @@ -299,8 +299,8 @@ CPRunContinuesResponse = -1002; } /*! - Stops the event loop started by <code>runModalForWindow:</code> and - sets the code that <code>runModalForWindow:</code> will return. + Stops the event loop started by \c -runModalForWindow: and + sets the code that \c -runModalForWindow: will return. @param aCode the return code for the modal event */ - (void)stopModalWithCode:(int)aCode @@ -341,7 +341,7 @@ CPRunContinuesResponse = -1002; } /*! - Aborts the event loop started by <code>runModalForWindow:</code> + Aborts the event loop started by \c -runModalForWindow: */ - (void)abortModal { @@ -349,7 +349,7 @@ CPRunContinuesResponse = -1002; } /*! - Sets up a modal session with <code>theWindow</code>. + Sets up a modal session with \c theWindow. @param aWindow the window to set up the modal session for */ - (CPModalSession)beginModalSessionForWindow:(CPWindow)aWindow @@ -378,7 +378,7 @@ CPRunContinuesResponse = -1002; /*! Returns the window for the current modal session. If there is no - modal session, it returns <code>nil</code>. + modal session, it returns \c nil. */ - (CPWindow)modalWindow { @@ -446,7 +446,7 @@ CPRunContinuesResponse = -1002; } /*! - Returns the CPWindow object corresponding to <code>aWindowNumber</code>. + Returns the CPWindow object corresponding to \c aWindowNumber. */ - (CPWindow)windowWithWindowNumber:(int)aWindowNumber { @@ -502,7 +502,7 @@ CPRunContinuesResponse = -1002; @param anAction the action to perform. @param anObject the argument for the action method - @return <code>YES</code> if the action was performed + @return \c YES if the action was performed */ - (BOOL)tryToPerform:(SEL)anAction with:(id)anObject { @@ -527,7 +527,7 @@ CPRunContinuesResponse = -1002; @param anAction the action to send @param aTarget the target for the action @param aSender the action sender - @return <code>YES</code> + @return \c YES */ - (BOOL)sendAction:(SEL)anAction to:(id)aTarget from:(id)aSender { @@ -543,12 +543,12 @@ CPRunContinuesResponse = -1002; /*! Finds a target for the specified action. If the - action is <code>nil</code>, returns <code>nil</code>. - If the target is not <code>nil</code>, <code>aTarget</code> is - returned. Otherwise, it calls <code>targetForAction:</code> + action is \c nil, returns \c nil. + If the target is not \c nil, \c aTarget is + returned. Otherwise, it calls \c -targetForAction: to search for a target. @param anAction the action to find a target for - @param aTarget if not <code>nil</code>, this will be returned + @param aTarget if not \c nil, this will be returned @aSender not used @return a target for the action */ @@ -576,7 +576,7 @@ CPRunContinuesResponse = -1002; </ol> @param aWindow the window to search for a target @param anAction the action to find a responder to - @return the object that responds to the action, or <code>nil</code> + @return the object that responds to the action, or \c nil if no matching target was found @ignore */ @@ -628,7 +628,7 @@ CPRunContinuesResponse = -1002; <li>the document controller</li> </ol> @param anAction the action to handle - @return a target that can respond, or <code>nil</code> + @return a target that can respond, or \c nil if no match could be found */ - (id)targetForAction:(SEL)anAction @@ -758,7 +758,7 @@ var _CPRunModalLoop = function(anEvent) /*! Starts the GUI and Cappuccino frameworks. This function should be - called from the <code>main()</code> function of your program. + called from the \c main() function of your program. @class CPApplication @return void */ AppKit/CPApplication.j @@ -172,7 +172,7 @@ CPButtonStateMixed = CPThemeState("mixed"); // Setting the state /*! - Returns <code>YES</code> if the button has a 'mixed' state in addition to on and off. + Returns \c YES if the button has a 'mixed' state in addition to on and off. */ - (BOOL)allowsMixedState { @@ -248,9 +248,9 @@ CPButtonStateMixed = CPThemeState("mixed"); } /*! - Sets the button's state to <code>aState</code>. + Sets the button's state to \c aState. @param aState Possible states are any of the CPButton globals: - <code>CPOffState, CPOnState, CPMixedState</code> + \c CPOffState, \c CPOnState, \c CPMixedState */ - (void)setState:(CPInteger)aState { @@ -602,7 +602,7 @@ var CPButtonImageKey = @"CPButtonImageKey", @implementation CPButton (CPCoding) /*! - Initializes the button by unarchiving data from <code>aCoder</code>. + Initializes the button by unarchiving data from \c aCoder. @param aCoder the coder containing the archived CPButton. */ - (id)initWithCoder:(CPCoder)aCoder AppKit/CPButton.j @@ -38,8 +38,8 @@ } /*! - Sets the document view to be <code>aView</code>. - @param aView the new document view. It's frame origin will be changed to <code>(0,0)</code> after calling this method. + Sets the document view to be \c aView. + @param aView the new document view. It's frame origin will be changed to \c (0,0) after calling this method. */ - (void)setDocumentView:(CPView)aView { @@ -95,7 +95,7 @@ } /*! - Returns a new point that may be adjusted from <code>aPoint</code> + Returns a new point that may be adjusted from \c aPoint to make sure it lies within the document view. @param aPoint @return the adjusted point @@ -128,7 +128,7 @@ /*! Scrolls the clip view to the specified point. The method - sets its bounds origin to <code>aPoint</code>. + sets its bounds origin to \c aPoint. */ - (void)scrollToPoint:(CGPoint)aPoint { AppKit/CPClipView.j @@ -122,7 +122,7 @@ } /*! - Sets the item prototype to <code>anItem</code> + Sets the item prototype to \c anItem @param anItem the new item prototype */ - (void)setItemPrototype:(CPCollectionViewItem)anItem @@ -143,7 +143,7 @@ } /*! - Returns a collection view item for <code>anObject</code>. + Returns a collection view item for \c anObject. @param anObject the object to be represented. */ - (CPCollectionViewItem)newItemForRepresentedObject:(id)anObject @@ -163,7 +163,7 @@ // Working with the Responder Chain /*! - Returns <code>YES</code> by default. + Returns \c YES by default. */ - (BOOL)acceptsFirstResponder { @@ -180,8 +180,8 @@ // Setting the Content /*! - Sets the content of the collection view to the content in <code>anArray</code>. - This array can be of any type, and each element will be passed to the <code>setRepresentedObject:</code> method. + Sets the content of the collection view to the content in \c anArray. + This array can be of any type, and each element will be passed to the \c -setRepresentedObject: method. It's the responsibility of your custom collection view item to interpret the object. @param anArray the content array */ @@ -214,7 +214,7 @@ // Setting the Selection Mode /*! Sets whether the user is allowed to select items - @param isSelectable <code>YES</code> allows the user to select items. + @param isSelectable \c YES allows the user to select items. */ - (void)setSelectable:(BOOL)isSelectable { @@ -233,8 +233,8 @@ } /*! - Returns <code>YES</code> if the collection view is - selected, and <code>NO</code> otherwise. + Returns \c YES if the collection view is + selected, and \c NO otherwise. */ - (BOOL)isSelected { @@ -243,7 +243,7 @@ /*! Sets whether the user may have no items selected. If YES, mouse clicks not on any item will empty the current selection. The first item will also start off as selected. - @param shouldAllowMultipleSelection <code>YES</code> allows the user to select multiple items + @param shouldAllowMultipleSelection \c YES allows the user to select multiple items */ - (void)setAllowsEmptySelection:(BOOL)shouldAllowEmptySelection { @@ -251,7 +251,7 @@ } /*! - Returns <code>YES</code> if the user can select no items, <code>NO</code> otherwise. + Returns \c YES if the user can select no items, \c NO otherwise. */ - (BOOL)allowsEmptySelection { @@ -260,7 +260,7 @@ /*! Sets whether the user can select multiple items. - @param shouldAllowMultipleSelection <code>YES</code> allows the user to select multiple items + @param shouldAllowMultipleSelection \c YES allows the user to select multiple items */ - (void)setAllowsMultipleSelection:(BOOL)shouldAllowMultipleSelection { @@ -268,7 +268,7 @@ } /*! - Returns <code>YES</code> if the user can select multiple items, <code>NO</code> otherwise. + Returns \c YES if the user can select multiple items, \c NO otherwise. */ - (BOOL)allowsMultipleSelection { @@ -684,7 +684,7 @@ // Modifying the Selection /*! Sets whether this view item should be selected. - @param shouldBeSelected <code>YES</code> makes the item selected. <code>NO</code> deselects it. + @param shouldBeSelected \c YES makes the item selected. \c NO deselects it. */ - (void)setSelected:(BOOL)shouldBeSelected { @@ -698,7 +698,7 @@ } /*! - Returns <code>YES</code> if the item is currently selected. <code>NO</code> if the item is not selected. + Returns \c YES if the item is currently selected. \c NO if the item is not selected. */ - (BOOL)isSelected { AppKit/CPCollectionView.j @@ -58,13 +58,13 @@ var cachedBlackColor, @ingroup appkit @code CPColor - <code>CPColor</code> can be used to represent color + \c CPColor can be used to represent color in an RGB or HSB model with an optional transparency value.</p> <p>It also provides some class helper methods that returns instances of commonly used colors.</p> - <p>The class does not have a <code>set:</code> method + <p>The class does not have a \c -set: method like NextStep based frameworks to change the color of the current context. To change the color of the current context, use CGContextSetFillColor(). @@ -117,7 +117,7 @@ var cachedBlackColor, /*! - Creates a new color object with <code>white</code> for the RGB components. + Creates a new color object with \c white for the RGB components. For the alpha component, a value of 1.0 is opaque, and 0.0 means completely transparent. @param white a float between 0.0 and 1.0 @@ -133,7 +133,7 @@ var cachedBlackColor, /*! @deprecated in favor of colorWithWhite:apha: - Creates a new color object with <code>white</code> for the RGB components. + Creates a new color object with \c white for the RGB components. For the alpha component, a value of 1.0 is opaque, and 0.0 means completely transparent. @param white a float between 0.0 and 1.0 @@ -376,7 +376,7 @@ var cachedBlackColor, } /*! - Creates a color using a tile pattern with <code>anImage</code> + Creates a color using a tile pattern with \c anImage @param the image to tile @return a tiled image color object */ @@ -726,7 +726,7 @@ var CPColorComponentsKey = @"CPColorComponentsKey", var hexCharacters = "0123456789ABCDEF"; /*! - Used for the CPColor <code>colorWithHexString:</code> implementation + Used for the CPColor \c +colorWithHexString: implementation @ignore @class CPColor @return an array of rgb components AppKit/CPColor.j @@ -58,7 +58,7 @@ CPColorPickerViewHeight = 370; CPColorPanel provides a reusable panel that can be used displayed on screen to prompt the user for a color selection. To - obtain the panel, call the <code>sharedColorPanel</code> method. + obtain the panel, call the \c +sharedColorPanel method. */ @implementation CPColorPanel : CPPanel { @@ -111,7 +111,7 @@ CPColorPickerViewHeight = 370; } /* - To obtain the color panel, use <code>sharedColorPanel</code>. + To obtain the color panel, use \c +sharedColorPanel. @ignore */ - (id)init @@ -137,7 +137,7 @@ CPColorPickerViewHeight = 370; } /*! - Sets the color of the panel, and updates the picker. Also posts a <code>CPColorPanelDidChangeNotification</code>. + Sets the color of the panel, and updates the picker. Also posts a \c CPColorPanelDidChangeNotification. */ - (void)setColor:(CPColor)aColor { AppKit/CPColorPanel.j @@ -27,7 +27,7 @@ @ingroup appkit @class 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. + CPColorPicker is an abstract superclass for all color picker subclasses. If you want a particular color picker, use CPColorPanel's \c +setPickerMode: method. The simplest way to implement your own color picker is to create a subclass of CPColorPicker. */ @implementation CPColorPicker : CPObject { @@ -60,7 +60,7 @@ /* FIXME Not implemented. - @return <code>nil</code> + @return \c nil @ignore */ - (CPImage)provideNewButtonImage AppKit/CPColorPicker.j @@ -35,7 +35,7 @@ var _CPColorWellDidBecomeExclusiveNotification = @"_CPColorWellDidBecomeExclusiv 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 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. + <p>An application can have one or more active CPColorWells. You can activate multiple CPColorWells by invoking the \c -activate: method with \c 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 { @@ -127,7 +127,7 @@ var _CPColorWellDidBecomeExclusiveNotification = @"_CPColorWellDidBecomeExclusiv } /*! - Changes the color of the well to that of <code>aSender</code>. + Changes the color of the well to that of \c aSender. @param aSender the object from which to retrieve the color */ - (void)takeColorFrom:(id)aSender @@ -138,7 +138,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 CPColorWells. <code>NO</code>, keeps them active. + If exclusive is \c YES, deactivates any other CPColorWells. \c NO, keeps them active. @param shouldBeExclusive whether other color wells should be deactivated. */ - (void)activate:(BOOL)shouldBeExclusive @@ -179,7 +179,7 @@ var _CPColorWellDidBecomeExclusiveNotification = @"_CPColorWellDidBecomeExclusiv } /*! - Returns <code>YES</code> if the color well is active. + Returns \c YES if the color well is active. */ - (BOOL)isActive { @@ -262,7 +262,7 @@ var CPColorWellColorKey = "CPColorWellColorKey", @implementation CPColorWell (CPCoding) /*! - Initializes the color well by unarchiving data from <code>aCoder</code>. + Initializes the color well by unarchiving data from \c aCoder. @param aCoder the coder containing the archived CPColorWell. */ - (id)initWithCoder:(CPCoder)aCoder AppKit/CPColorWell.j @@ -178,7 +178,7 @@ var CPControlBlackColor = [CPColor blackColor]; } /*! - Causes <code>anAction</code> to be sent to <code>anObject</code>. + Causes \c anAction to be sent to \c anObject. @param anAction the action to send @param anObject the object to which the action will be sent */ AppKit/CPControl.j @@ -38,7 +38,7 @@ } /*! - Initializes a cookie with a given name <code>aName</code>. + Initializes a cookie with a given name \c aName. @param the name for the cookie */ - (id)initWithName:(CPString)aName AppKit/CPCookie.j @@ -176,8 +176,8 @@ var CPDocumentUntitledCount = 0; @param absoluteContentsURL the location of the document's contents @param aType the type of the contents @param aDelegate this object will receive a callback after the document's contents are loaded - @param aDidReadSelector the message selector that will be sent to <code>aDelegate</code> - @param aContextInfo passed as the argument to the message sent to the <code>aDelegate</code> + @param aDidReadSelector the message selector that will be sent to \c aDelegate + @param aContextInfo passed as the argument to the message sent to the \c aDelegate @return the initialized document */ - (id)initForURL:(CPURL)anAbsoluteURL withContentsOfURL:(CPURL)absoluteContentsURL ofType:(CPString)aType delegate:(id)aDelegate didReadSelector:(SEL)aDidReadSelector contextInfo:(id)aContextInfo @@ -295,7 +295,7 @@ var CPDocumentUntitledCount = 0; } /*! - Called after <code>aWindowController<code> loads the document's Nib file. + Called after \c aWindowController loads the document's Nib file. @param aWindowController the controller that loaded the Nib file */ - (void)windowControllerDidLoadCib:(CPWindowController)aWindowController @@ -303,7 +303,7 @@ var CPDocumentUntitledCount = 0; } /*! - Called before <code>aWindowController</code> will load the document's Nib file. + Called before \c aWindowController will load the document's Nib file. @param aWindowController the controller that will load the Nib file */ - (void)windowControllerWillLoadCib:(CPWindowController)aWindowController @@ -505,7 +505,7 @@ var CPDocumentUntitledCount = 0; // Managing Document Status /*! - Returns <code>YES</code> if there are any unsaved changes. + Returns \c YES if there are any unsaved changes. */ - (BOOL)isDocumentEdited { @@ -551,7 +551,7 @@ var CPDocumentUntitledCount = 0; // Working with Undo Manager /*! - Returns <code>YES</code> if the document has a + Returns \c YES if the document has a CPUndoManager. */ - (BOOL)hasUndoManager @@ -561,7 +561,7 @@ var CPDocumentUntitledCount = 0; /*! Sets whether the document should have a CPUndoManager. - @param aFlag <code>YES</code> makes the document have an undo manager + @param aFlag \c YES makes the document have an undo manager */ - (void)setHasUndoManager:(BOOL)aFlag { @@ -645,7 +645,7 @@ var CPDocumentUntitledCount = 0; /*! Returns the document's undo manager. If the document - should have one, but the manager is <code>nil</code>, it + should have one, but the manager is \c nil, it will be created and then returned. @return the document's undo manager */ @@ -669,8 +669,8 @@ var CPDocumentUntitledCount = 0; // Handling User Actions /*! Saves the document. If the document does not - have a file path to save to (<code>fileURL</code>) - then <code>saveDocumentAs:</code> will be called. + have a file path to save to (\c fileURL) + then \c -saveDocumentAs: will be called. @param aSender the object requesting the save */ - (void)saveDocument:(id)aSender AppKit/CPDocument.j @@ -78,7 +78,7 @@ var CPSharedDocumentController = nil; method searches documents already open. It does not open the document at the URL if it is not already open. @param aURL the url of the document - @return the document, or <code>nil</code> if such a document is not open + @return the document, or \c nil if such a document is not open */ - (CPDocument)documentForURL:(CPURL)aURL { @@ -157,7 +157,7 @@ var CPSharedDocumentController = nil; @param anAbsoluteURL the document URL @param absoluteContentsURL the location of the document's contents @param anError not used - @return the loaded document or <code>nil</code> if there was an error + @return the loaded document or \c nil if there was an error */ - (CPDocument)reopenDocumentForURL:(CPURL)anAbsoluteURL withContentsOfURL:(CPURL)absoluteContentsURL error:(CPError)anError { @@ -187,7 +187,7 @@ var CPSharedDocumentController = nil; @param aDelegate receives a callback after the load has completed @param aSelector the selector to invoke for the callback @param aContextInfo an object passed as an argument for the callback - @return a new document or <code>nil</code> if there was an error + @return a new document or \c nil if there was an error */ - (CPDocument)makeDocumentForURL:(CPURL)anAbsoluteURL withContentsOfURL:(CPURL)absoluteContentsURL ofType:(CPString)aType delegate:(id)aDelegate didReadSelector:(SEL)aSelector contextInfo:(id)aContextInfo { @@ -231,7 +231,7 @@ var CPSharedDocumentController = nil; } /*! - Adds <code>aDocument</code> under the control of the receiver. + Adds \c aDocument under the control of the receiver. @param aDocument the document to add */ - (void)addDocument:(CPDocument)aDocument @@ -240,7 +240,7 @@ var CPSharedDocumentController = nil; } /*! - Removes <code>aDocument</code> from the control of the receiver. + Removes \c aDocument from the control of the receiver. @param aDocument the document to remove */ - (void)removeDocument:(CPDocument)aDocument @@ -296,9 +296,9 @@ var CPSharedDocumentController = nil; } /*! - Returns the CPDocument subclass associated with <code>aType</code>. + Returns the CPDocument subclass associated with \c aType. @param aType the type of document - @return a Cappuccino Class object, or <code>nil</code> if no match was found + @return a Cappuccino Class object, or \c nil if no match was found */ - (Class)documentClassForType:(CPString)aType { AppKit/CPDocumentController.j @@ -236,7 +236,7 @@ var CPDragServerUpdateDragging = function(anEvent) @param anEvent @param aPasteboard the pasteboard that contains the drag data @param aSourceObject the object where the drag started - @param slideBack if <code>YES</code>, <code>aView</code> slides back to + @param slideBack if \c YES, \c aView slides back to its origin on a failed drop */ - (void)dragView:(CPView)aView fromWindow:(CPWindow)aWindow at:(CGPoint)viewLocation offset:(CGSize)mouseOffset event:(CPEvent)anEvent pasteboard:(CPPasteboard)aPasteboard source:(id)aSourceObject slideBack:(BOOL)slideBack @@ -298,7 +298,7 @@ var CPDragServerUpdateDragging = function(anEvent) @param anEvent @param aPasteboard the pasteboard where the drag data is located @param aSourceObject the object where the drag started - @param slideBack if <code>YES</code>, <code>aView</code> slides back to + @param slideBack if \c YES, \c aView slides back to its origin on a failed drop */ - (void)dragImage:(CPImage)anImage fromWindow:(CPWindow)aWindow at:(CGPoint)imageLocation offset:(CGSize)mouseOffset event:(CPEvent)anEvent pasteboard:(CPPasteboard)aPasteboard source:(id)aSourceObject slideBack:(BOOL)slideBack AppKit/CPDragServer.j @@ -221,16 +221,16 @@ var _CPEventPeriodicEventPeriod = 0, /*! Creates a new keyboard event. @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 aPoint the location of the cursor in the window specified by \c aWindowNumber @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 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 repeatKey \c 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 <code>anEventType</code> is not a CPKeyDown, + @throws CPInternalInconsistencyException if \c anEventType is not a CPKeyDown, CPKeyUp or CPFlagsChanged @return the keyboard event */ @@ -246,7 +246,7 @@ 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 aPoint the location of the cursor in the window specified by \c aWindowNumber @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 @@ -268,7 +268,7 @@ var _CPEventPeriodicEventPeriod = 0, /*! Creates a new custom event @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 aLocation the location of the cursor in the window specified by \c aWindowNumber @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 @@ -358,11 +358,11 @@ var _CPEventPeriodicEventPeriod = 0, /*! Returns the location of the mouse (for mouse events). - If this is not a mouse event, it returns <code>nil</code>. - If <code>window</code> returns <code>nil</code>, then + If this is not a mouse event, it returns \c nil. + If \c window returns \c nil, then the mouse coordinates will be based on the screen coordinates. Otherwise, the coordinates are relative to the window's coordinates. - @return the location of the mouse, or <code>nil</code> for non-mouse events. + @return the location of the mouse, or \c nil for non-mouse events. */ - (CGPoint)locationInWindow { @@ -448,7 +448,7 @@ var _CPEventPeriodicEventPeriod = 0, } /*! - Returns <code>YES</code> if the keyboard event was caused by the key being held down. + Returns \c YES if the keyboard event was caused by the key being held down. @throws CPInternalInconsistencyException if this method is called on a non-key event */ - (BOOL)isARepeat @@ -504,7 +504,7 @@ var _CPEventPeriodicEventPeriod = 0, } /*! - Generates periodic events every <code>aPeriod</code> seconds. + Generates periodic events every \c aPeriod seconds. @param aDelay the number of seconds before the first event @param aPeriod the length of time in seconds between successive events */ AppKit/CPEvent.j @@ -34,7 +34,7 @@ } /*! - Creates a new Flash movie with the swf at <code>aFileName</code>. + Creates a new Flash movie with the swf at \c aFileName. @param aFilename the swf to load @return the initialized CPFlashMovie */ AppKit/CPFlashMovie.j @@ -62,11 +62,11 @@ function CPPointMake(x, y) } /*! - Makes a CGRect with an origin and size equal to <code>aRect</code> less the <code>dX/dY</code> insets specified. + Makes a CGRect with an origin and size equal to \c aRect less the \c dX/dY insets specified. @param dX the size of the inset in the x-axis @param dY the size of the inset in the y-axis @group CGRect - @return CGRect a rectangle like <code>aRect</code> with an inset + @return CGRect a rectangle like \c aRect with an inset */ function CPRectInset(aRect, dX, dY) { @@ -132,7 +132,7 @@ function CPRectMake(x, y, width, height) } /*! - Creates a new rectangle with its origin offset by <code>dX</code> and <code>dY</code>. + Creates a new rectangle with its origin offset by \c dX and \c dY. @group CGRect @param aRect the rectangle to copy the origin and size from @param dX the amount added to the x-size of the new rectangle @@ -171,7 +171,7 @@ function CPRectStandardize(aRect) } /*! - Returns the smallest rectangle that can contain the two argument <code>CGRect</code>s. + Returns the smallest rectangle that can contain the two argument \c CGRects. @group CGRect @param lhsRect the first CGRect to use for the union calculation @param rhsRect the second CGRect to use for the union calculation @@ -211,12 +211,12 @@ function CPSizeMake(width, height) } /*! - Returns <code>YES</code> if the CGRect, <code>aRect</code>, contains - the CGPoint, <code>aPoint</code>. + Returns \c YES if the CGRect, \c aRect, contains + the CGPoint, \c aPoint. @param aRect the rectangle to test with @param aPoint the point to test with @group CGRect - @return BOOL <code>YES</code> if the rectangle contains the point, <code>NO</code> otherwise. + @return BOOL \c YES if the rectangle contains the point, \c NO otherwise. */ function CPRectContainsPoint(aRect, aPoint) { @@ -227,12 +227,12 @@ function CPRectContainsPoint(aRect, aPoint) } /*! - Returns a <code>BOOL</code> indicating whether CGRect <code>possibleOuter</code> - contains CGRect <code>possibleInner</code>. + Returns a \c BOOL indicating whether CGRect \c possibleOuter + contains CGRect \c possibleInner. @group CGRect - @param possibleOuter the CGRect to test if <code>possibleInner</code> is inside of - @param possibleInner the CGRect to test if it fits inside <code>possibleOuter</code>. - @return BOOL <code>YES</code> if <code>possibleInner</code> fits inside <code>possibleOuter</code>. + @param possibleOuter the CGRect to test if \c possibleInner is inside of + @param possibleInner the CGRect to test if it fits inside \c possibleOuter. + @return BOOL \c YES if \c possibleInner fits inside \c possibleOuter. */ function CPRectContainsRect(lhsRect, rhsRect) { @@ -241,11 +241,11 @@ function CPRectContainsRect(lhsRect, rhsRect) /*! Tests whether the two CGPoints are equal to each other by comparing their - <code>x</code> and <code>y</code> members. + \c x and \c y members. @group @CGPoint @param lhsPoint the first CGPoint to check @param rhsPoint the second CGPoint to check - @return BOOL <code>YES</code> if the two points have the same x's, and the same y's. + @return BOOL \c YES if the two points have the same x's, and the same y's. */ function CPPointEqualToPoint(lhsPoint, rhsPoint) { @@ -257,7 +257,7 @@ function CPPointEqualToPoint(lhsPoint, rhsPoint) @group CGRect @param lhsRect the first CGRect to compare @param rhsRect the second CGRect to compare - @return BOOL <code>YES</code> if the two rectangles have the same origin and size. <code>NO</code>, otherwise. + @return BOOL \c YES if the two rectangles have the same origin and size. \c NO, otherwise. */ function CPRectEqualToRect(lhsRect, rhsRect) { @@ -346,11 +346,11 @@ function CPRectGetWidth(aRect) } /*! - Returns <code>YES</code> if the two rectangles intersect + Returns \c YES if the two rectangles intersect @group CGRect @param lhsRect the first CGRect @param rhsRect the second CGRect - @return BOOL <code>YES</code> if the two rectangles have any common spaces, and <code>NO</code>, otherwise. + @return BOOL \c YES if the two rectangles have any common spaces, and \c NO, otherwise. */ function CPRectIntersectsRect(lhsRect, rhsRect) { @@ -358,11 +358,11 @@ function CPRectIntersectsRect(lhsRect, rhsRect) } /*! - Returns <code>YES</code> if the CGRect has no area. + Returns \c 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 <code>YES</code> if the CGRect has no area, and <code>NO</code>, otherwise. + @return BOOL \c YES if the CGRect has no area, and \c NO, otherwise. */ function CPRectIsEmpty(aRect) { @@ -370,10 +370,10 @@ function CPRectIsEmpty(aRect) } /*! - Returns <code>YES</code> if the CGRect has no area. + Returns \c 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 <code>YES</code> if the CGRect has no area, and <code>NO</code>, otherwise. + @return BOOL \c YES if the CGRect has no area, and \c NO, otherwise. */ function CPRectIsNull(aRect) { @@ -381,11 +381,11 @@ function CPRectIsNull(aRect) } /*! - Returns <code>YES</code> if the two CGSizes are identical. + Returns \c YES if the two CGSizes are identical. @group CGSize @param lhsSize the first CGSize to compare @param rhsSize the second CGSize to compare - @return BOOL <code>YES</code> if the two sizes are identical. <code>NO</code>, otherwise. + @return BOOL \c YES if the two sizes are identical. \c NO, otherwise. */ function CPSizeEqualToSize(lhsSize, rhsSize) { @@ -454,7 +454,7 @@ function CPSizeFromString(aString) /*! Returns a CGRect created from a string. @group CGRect - @param aString a string in the form generated by <code>CPStringFromRect</code> + @param aString a string in the form generated by \c CPStringFromRect @return CGRect the rectangle created from the string */ function CPRectFromString(aString) @@ -477,7 +477,7 @@ function CPPointFromEvent(anEvent) /*! Returns a zero sized CGSize. @group CGSize - @return CGSize a size object with zeros for <code>width</code> and <code>height</code> + @return CGSize a size object with zeros for \c width and \c height */ function CPSizeMakeZero() { @@ -485,7 +485,7 @@ function CPSizeMakeZero() } /*! - Returns a rectangle at origin <code>(0,0)</code> and size of <code>(0,0)</code>. + Returns a rectangle at origin \c (0,0) and size of \c (0,0). @group CGRect @return CGRect a zeroed out CGRect */ @@ -495,9 +495,9 @@ function CPRectMakeZero() } /*! - Returns a point located at <code>(0, 0)</code>. + Returns a point located at \c (0, 0). @group CGPoint - @return CGPoint a point located at <code>(0, 0)</code> + @return CGPoint a point located at \c (0, 0) */ function CPPointMakeZero() { AppKit/CPGeometry.j @@ -92,7 +92,7 @@ function CPImageInBundle(aFilename, aSize, aBundle) /*! Initializes the image, by associating it with a filename. The image - denoted in <code>aFilename</code> is not actually loaded. It will + denoted in \c aFilename is not actually loaded. It will be loaded once needed. @param aFilename the file containing the image @param aSize the image's size AppKit/CPImage.j @@ -161,8 +161,8 @@ var LEFT_SHADOW_INSET = 3.0, } /*! - Returns <code>YES</code> if the image view draws with - a drop shadow. The default is <code>NO</code>. + Returns \c YES if the image view draws with + a drop shadow. The default is \c NO. */ - (BOOL)hasShadow { AppKit/CPImageView.j @@ -369,7 +369,7 @@ var _CPMenuBarVisible = NO, /*! Returns the menu item with the specified tag @param the tag of the desired menu item - @return the menu item or <code>nil</code> if a match was not found + @return the menu item or \c nil if a match was not found */ - (CPMenuItem)menuWithTag:(int)aTag { @@ -384,7 +384,7 @@ var _CPMenuBarVisible = NO, /*! Returns the menu item with the specified title. @param aTitle the title of the menu item - @return the menu item or <code>nil</code> if a match was not found + @return the menu item or \c nil if a match was not found */ - (CPMenuItem)menuWithTitle:(CPString)aTitle { @@ -551,7 +551,7 @@ var _CPMenuBarVisible = NO, } /*! - Returns the attaced menu, or <code>nil</code> if there isn't one. + Returns the attaced menu, or \c nil if there isn't one. */ - (CPMenu)attachedMenu { @@ -559,7 +559,7 @@ var _CPMenuBarVisible = NO, } /*! - Returns <code>YES</code> if the menu is attached to another menu. + Returns \c YES if the menu is attached to another menu. */ - (BOOL)isAttached { @@ -575,7 +575,7 @@ var _CPMenuBarVisible = NO, } /*! - Returns the super menu or <code>nil</code> if there is none. + Returns the super menu or \c nil if there is none. */ - (CPMenu)supermenu { @@ -592,8 +592,8 @@ var _CPMenuBarVisible = NO, } /*! - If there are two instances of this menu visible, return <code>NO</code>. - Otherwise, return <code>YES</code> if we are a detached menu and visible. + If there are two instances of this menu visible, return \c NO. + Otherwise, return \c YES if we are a detached menu and visible. */ - (BOOL)isTornOff { @@ -603,7 +603,7 @@ var _CPMenuBarVisible = NO, // Enabling and Disabling Menu Items /*! Sets whether the menu automatically enables menu items. - @param aFlag <code>YES</code> sets the menu to automatically enable items. + @param aFlag \c YES sets the menu to automatically enable items. */ - (void)setAutoenablesItems:(BOOL)aFlag { @@ -611,7 +611,7 @@ var _CPMenuBarVisible = NO, } /*! - Returns <code>YES</code> if the menu auto enables items. + Returns \c YES if the menu auto enables items. */ - (BOOL)autoenablesItems { @@ -691,7 +691,7 @@ var _CPMenuBarVisible = NO, // Managing Display of State Column /*! Sets whether to show the state column - @param shouldShowStateColumn <code>YES</code> shows the state column + @param shouldShowStateColumn \c YES shows the state column */ - (void)setShowsStateColumn:(BOOL)shouldShowStateColumn { @@ -699,7 +699,7 @@ var _CPMenuBarVisible = NO, } /*! - Returns <code>YES</code> if the menu shows the state column + Returns \c YES if the menu shows the state column */ - (BOOL)showsStateColumn { @@ -709,7 +709,7 @@ var _CPMenuBarVisible = NO, // Handling Highlighting /*! Returns the currently highlighted menu item. - @return the highlighted menu item or <code>nil</code> if no item is currently highlighted + @return the highlighted menu item or \c nil if no item is currently highlighted */ - (CPMenuItem)highlightedItem { @@ -745,9 +745,9 @@ var _CPMenuBarVisible = NO, /*! Initiates the action of the menu item that - has a keyboard shortcut equivalent to <code>anEvent</code> + has a keyboard shortcut equivalent to \c anEvent @param anEvent the keyboard event - @return <code>YES</code> if it was handled. + @return \c YES if it was handled. */ - (BOOL)performKeyEquivalent:(CPEvent)anEvent { AppKit/CPMenu.j @@ -113,7 +113,7 @@ // Enabling a Menu Item /*! Sets whether the menu item is enabled or not - @param isEnabled <code>YES</code> enables the item. <code>NO</code> disables it. + @param isEnabled \c YES enables the item. \c NO disables it. */ - (void)setEnabled:(BOOL)isEnabled { @@ -128,7 +128,7 @@ } /*! - Returns <code>YES</code> if the item is enabled. + Returns \c YES if the item is enabled. */ - (BOOL)isEnabled { @@ -138,7 +138,7 @@ // Managing Hidden Status /*! Sets whether the item should be hidden. A hidden item can not be triggered by keyboard shortcuts. - @param isHidden <code>YES</code> hides the item. <code>NO</code> reveals it. + @param isHidden \c YES hides the item. \c NO reveals it. */ - (void)setHidden:(BOOL)isHidden { @@ -151,7 +151,7 @@ } /*! - Returns <code>YES</code> if the item is hidden. + Returns \c YES if the item is hidden. */ - (BOOL)isHidden { @@ -159,7 +159,7 @@ } /*! - Returns <code>YES</code> if the item is hidden or if one of it's supermenus is hidden. + Returns \c YES if the item is hidden or if one of it's supermenus is hidden. */ - (BOOL)isHiddenOrHasHiddenAncestor { @@ -461,7 +461,7 @@ CPOffState } /*! - Returns the submenu of the item. <code>nil</code> if there is no submenu. + Returns the submenu of the item. \c nil if there is no submenu. */ - (CPMenu)submenu { @@ -469,7 +469,7 @@ CPOffState } /*! - Returns <code>YES</code> if the menu item has a submenu. + Returns \c YES if the menu item has a submenu. */ - (BOOL)hasSubmenu { @@ -491,7 +491,7 @@ CPOffState } /*! - Returns <code>YES</code> if the menu item is a separator. + Returns \c YES if the menu item is a separator. */ - (BOOL)isSeparatorItem { @@ -613,7 +613,7 @@ CPControlKeyMask /*! Sets whether this item is an alternate for the previous menu item. - @param isAlternate <code>YES</code> denotes that this menu item is an alternate + @param isAlternate \c YES denotes that this menu item is an alternate */ - (void)setAlternate:(BOOL)isAlternate { @@ -621,7 +621,7 @@ CPControlKeyMask } /*! - Returns <code>YES</code> if the menu item is an alternate for the previous item. + Returns \c YES if the menu item is an alternate for the previous item. */ - (BOOL)isAlternate { @@ -717,7 +717,7 @@ CPControlKeyMask // Getting Highlighted Status /*! - Returns <code>YES</code> if the menu item is highlighted. + Returns \c YES if the menu item is highlighted. */ - (BOOL)isHighlighted { AppKit/CPMenuItem.j @@ -53,7 +53,7 @@ CPCancelButton = 0; } /*! - Returns <code>YES</code> if the receiver is a floating panel (like a palette). + Returns \c YES if the receiver is a floating panel (like a palette). */ - (BOOL)isFloatingPanel { @@ -61,8 +61,8 @@ CPCancelButton = 0; } /*! - Sets the receiver to be a floating panel. <code>YES</code> - makes the window a floating panel. <code>NO</code> makes it a normal window. + Sets the receiver to be a floating panel. \c YES + makes the window a floating panel. \c NO makes it a normal window. @param isFloatingPanel specifies whether to make it floating */ - (void)setFloatingPanel:(BOOL)isFloatingPanel @@ -71,8 +71,8 @@ CPCancelButton = 0; } /*! - Returns <code>YES</code> if the window only becomes key - if needed. <code>NO</code> means it behaves just like other windows. + Returns \c YES if the window only becomes key + if needed. \c NO means it behaves just like other windows. */ - (BOOL)becomesKeyOnlyIfNeeded { @@ -81,7 +81,7 @@ CPCancelButton = 0; /*! Sets whether the the window becomes key only if needed. - @param shouldBecomeKeyOnlyIfNeeded <code>YES</code> makes the window become key only if needed + @param shouldBecomeKeyOnlyIfNeeded \c YES makes the window become key only if needed */ - (void)setBecomesKeyOnlyIfNeeded:(BOOL)shouldBecomeKeyOnlyIfNeeded { AppKit/CPPanel.j @@ -173,7 +173,7 @@ var CPPasteboards = nil; Sets the pasteboard data for the specified type @param aData the data @param aType the data type being set - @return <code>YES</code> if the data was successfully written to the pasteboard + @return \c YES if the data was successfully written to the pasteboard */ - (BOOL)setData:(CPData)aData forType:(CPString)aType { @@ -186,7 +186,7 @@ var CPPasteboards = nil; Writes the specified property list as data for the specified type @param aPropertyList the property list to write @param aType the data type - @return <code>YES</code> if the property list was successfully written to the pasteboard + @return \c YES if the property list was successfully written to the pasteboard */ - (BOOL)setPropertyList:(id)aPropertyList forType:(CPString)aType { @@ -197,7 +197,7 @@ var CPPasteboards = nil; Sets the specified string as data for the specified type @param aString the string to write @param aType the data type - @return <code>YES</code> if the string was successfully written to the pasteboard + @return \c YES if the string was successfully written to the pasteboard */ - (void)setString:(CPString)aString forType:(CPString)aType { @@ -209,7 +209,7 @@ var CPPasteboards = nil; Checks the pasteboard's types for a match with the types listen in the specified array. The array should be ordered by the requestor's most preferred data type first. @param anArray an array of requested types ordered by preference - @return the highest match with the pasteboard's supported types or <code>nil</code> if no match was found + @return the highest match with the pasteboard's supported types or \c nil if no match was found */ - (CPString)availableTypeFromArray:(CPArray)anArray { @@ -236,7 +236,7 @@ var CPPasteboards = nil; /*! Returns the pasteboard data for the specified data type @param aType the requested data type - @return the requested data or <code>nil</code> if the data doesn't exist + @return the requested data or \c nil if the data doesn't exist */ - (CPData)dataForType:(CPString)aType { @@ -262,7 +262,7 @@ var CPPasteboards = nil; /*! Returns the property list for the specified data type @param aType the requested data type - @return the property list or <code>nil</code> if the list was not found + @return the property list or \c nil if the list was not found */ - (id)propertyListForType:(CPString)aType { @@ -277,7 +277,7 @@ var CPPasteboards = nil; /*! Returns the string for the specified data type @param aType the requested data type - @return the string or <code>nil</code> if the string was not found + @return the string or \c nil if the string was not found */ - (CPString)stringForType:(CPString)aType { AppKit/CPPasteboard.j @@ -54,7 +54,7 @@ CPPopUpButtonStatePullsDown = CPThemeState("pulls-down"); /*! Initializes the pop-up button to the specified size. @param aFrame the size for the button - @param shouldPullDown <code>YES</code> makes this a pull-down menu, <code>NO</code> makes it a pop-up menu. + @param shouldPullDown \c YES makes this a pull-down menu, \c NO makes it a pop-up menu. @return the initialized pop-up button */ - (id)initWithFrame:(CGRect)aFrame pullsDown:(BOOL)shouldPullDown @@ -87,8 +87,8 @@ CPPopUpButtonStatePullsDown = CPThemeState("pulls-down"); /*! Specifies whether the object is a pull-down or a pop-up menu. - @param shouldPullDown <code>YES</code> makes the pop-up button - a pull-down menu. <code>NO</code> makes it a pop-up menu. + @param shouldPullDown \c YES makes the pop-up button + a pull-down menu. \c NO makes it a pop-up menu. */ - (void)setPullsDown:(BOOL)shouldPullDown { @@ -111,7 +111,7 @@ CPPopUpButtonStatePullsDown = CPThemeState("pulls-down"); } /*! - Returns <code>YES</code> if the button is a pull-down menu. <code>NO</code> if the button is a pop-up menu. + Returns \c YES if the button is a pull-down menu. \c NO if the button is a pop-up menu. */ - (BOOL)pullsDown { @@ -200,7 +200,7 @@ CPPopUpButtonStatePullsDown = CPThemeState("pulls-down"); // Getting the User's Selection /*! - Returns the selected item or <code>nil</code> if no item is selected. + Returns the selected item or \c nil if no item is selected. */ - (CPMenuItem)selectedItem { @@ -211,7 +211,7 @@ CPPopUpButtonStatePullsDown = CPThemeState("pulls-down"); } /*! - Returns the title of the selected item or <code>nil</code> if no item is selected. + Returns the title of the selected item or \c nil if no item is selected. */ - (CPString)titleOfSelectedItem { @@ -372,7 +372,7 @@ CPPopUpButtonStatePullsDown = CPThemeState("pulls-down"); } /*! - Returns the item at the specified index or <code>nil</code> if the item does not exist. + Returns the item at the specified index or \c nil if the item does not exist. @param anIndex the index of the item to obtain */ - (CPMenuItem)itemAtIndex:(unsigned)anIndex @@ -381,7 +381,7 @@ CPPopUpButtonStatePullsDown = CPThemeState("pulls-down"); } /*! - Returns the title of the item at the specified index or <code>nil</code> if no item exists. + Returns the title of the item at the specified index or \c nil if no item exists. @param anIndex the index of the item */ - (CPString)itemTitleAtIndex:(unsigned)anIndex AppKit/CPPopUpButton.j @@ -205,7 +205,7 @@ var CPProgressIndicatorSpinningStyleColors = nil, } /*! - Always returns <code>NO</code>. Cappuccino does not have multiple threads. + Always returns \c NO. Cappuccino does not have multiple threads. */ - (BOOL)usesThreadedAnimation { @@ -329,7 +329,7 @@ var CPProgressIndicatorSpinningStyleColors = nil, /*! Specifies whether this progress indicator should be indeterminate or display progress based on it's max and min. - @param isDeterminate <code>YES</code> makes the indicator indeterminate + @param isDeterminate \c YES makes the indicator indeterminate */ - (void)setIndeterminate:(BOOL)isIndeterminate { @@ -342,7 +342,7 @@ var CPProgressIndicatorSpinningStyleColors = nil, } /*! - Returns <code>YES</code> if the progress bar is indeterminate. + Returns \c YES if the progress bar is indeterminate. */ - (BOOL)isIndeterminate { @@ -377,9 +377,9 @@ var CPProgressIndicatorSpinningStyleColors = nil, } /*! - Sets whether the indicator should be displayed when it isn't animating. By default this is <code>YES</code> if the style - is CPProgressIndicatorBarStyle, and <code>NO</code> if it's CPProgressIndicatorSpinningStyle. - @param isDisplayedWhenStopped <code>YES</code> means the indicator will be displayed when it's not animating. + Sets whether the indicator should be displayed when it isn't animating. By default this is \c YES if the style + is CPProgressIndicatorBarStyle, and \c NO if it's CPProgressIndicatorSpinningStyle. + @param isDisplayedWhenStopped \c YES means the indicator will be displayed when it's not animating. */ - (void)setDisplayedWhenStopped:(BOOL)isDisplayedWhenStopped { @@ -394,7 +394,7 @@ var CPProgressIndicatorSpinningStyleColors = nil, } /*! - Returns <code>YES</code> if the progress bar is displayed when not animating. + Returns \c YES if the progress bar is displayed when not animating. */ - (BOOL)isDisplayedWhenStopped { AppKit/CPProgressIndicator.j @@ -46,7 +46,7 @@ CPDownArrowKeyCode = 40; // Changing the first responder /*! - Returns <code>YES</code> if the receiver is able to become the first responder. <code>NO</code> otherwise. + Returns \c YES if the receiver is able to become the first responder. \c NO otherwise. */ - (BOOL)acceptsFirstResponder { @@ -55,8 +55,8 @@ CPDownArrowKeyCode = 40; /*! Notifies the receiver that it will become the first responder. The receiver can reject first - responder if it returns <code>NO</code>. The default implementation always returns <code>YES</code>. - @return <code>YES</code> if the receiver accepts first responder status. + responder if it returns \c NO. The default implementation always returns \c YES. + @return \c YES if the receiver accepts first responder status. */ - (BOOL)becomeFirstResponder { @@ -65,7 +65,7 @@ CPDownArrowKeyCode = 40; /*! Notifies the receiver that it has been asked to give up first responder status. - @return <code>YES</code> if the receiver is willing to give up first responder status. + @return \c YES if the receiver is willing to give up first responder status. */ - (BOOL)resignFirstResponder { @@ -216,9 +216,9 @@ CPDownArrowKeyCode = 40; /* FIXME This description is bad. - Based on <code>anEvent</code>, the receiver should simulate the event. + Based on \c anEvent, the receiver should simulate the event. @param anEvent the event to simulate - @return <code>YES</code> if the event receiver simulated the event + @return \c YES if the event receiver simulated the event */ - (BOOL)performKeyEquivalent:(CPEvent)anEvent { @@ -267,7 +267,7 @@ CPDownArrowKeyCode = 40; // Dispatch methods /*! The receiver will attempt to perform the command, - if it responds to it. If not, the <code>nextResponder</code> will be called to do it. + if it responds to it. If not, the \c -nextResponder will be called to do it. @param aSelector the command to attempt */ - (void)doCommandBySelector:(SEL)aSelector @@ -282,7 +282,7 @@ CPDownArrowKeyCode = 40; The receiver will attempt to perform the command, or pass it on to the next responder if it doesn't respond to it. @param aSelector the command to perform @param anObject the argument to the method - @return <code>YES</code> if the receiver was able to perform the command, or a responder down the chain was + @return \c YES if the receiver was able to perform the command, or a responder down the chain was able to perform the command. */ - (BOOL)tryToPerform:(SEL)aSelector with:(id)anObject AppKit/CPResponder.j @@ -269,7 +269,7 @@ /*! Specifies whether the scroll view can have a horizontal scroller. - @param hasHorizontalScroller <code>YES</code> lets the scroll view + @param hasHorizontalScroller \c YES lets the scroll view allocate a horizontal scroller if necessary. */ - (void)setHasHorizontalScroller:(BOOL)shouldHaveHorizontalScroller @@ -291,7 +291,7 @@ } /*! - Returns <code>YES</code> if the scroll view can have a horizontal scroller. + Returns \c YES if the scroll view can have a horizontal scroller. */ - (BOOL)hasHorizontalScroller { @@ -332,7 +332,7 @@ /*! Specifies whether the scroll view has can have a vertical scroller. It allocates it if necessary. - @param hasVerticalScroller <code>YES</code> allows + @param hasVerticalScroller \c YES allows the scroll view to display a vertical scroller */ - (void)setHasVerticalScroller:(BOOL)shouldHaveVerticalScroller @@ -354,7 +354,7 @@ } /*! - Returns <code>YES</code> if the scroll view can have a vertical scroller. + Returns \c YES if the scroll view can have a vertical scroller. */ - (BOOL)hasVerticalScroller { @@ -363,7 +363,7 @@ /*! Sets whether the scroll view hides its scoll bars when not needed. - @param autohidesScrollers <code>YES</code> causes the scroll bars + @param autohidesScrollers \c YES causes the scroll bars to be hidden when not needed. */ - (void)setAutohidesScrollers:(BOOL)autohidesScrollers @@ -377,7 +377,7 @@ } /*! - Returns <code>YES</code> if the scroll view hides its scroll + Returns \c YES if the scroll view hides its scroll bars when not necessary. */ - (BOOL)autohidesScrollers AppKit/CPScrollView.j @@ -208,7 +208,7 @@ NAMES_FOR_PARTS[CPScrollerKnob] = @"knob"; } /*! - Returns the part of the scroller that would be hit by <code>aPoint</code>. + Returns the part of the scroller that would be hit by \c aPoint. @param aPoint the simulated point hit @return the part of the scroller that intersects the point */ AppKit/CPScroller.j @@ -294,7 +294,7 @@ var CPSearchFieldSearchImage = nil, // Managing Search Modes /*! Returns a Boolean value indicating whether the receiver sends the search action message when the user clicks the search button (or presses return) or after each keystroke. - @return <code>YES</code> if the action message is sent all at once when the user clicks the search button or presses return; otherwise, NO if the search string is sent after each keystroke. The default value is NO. + @return \c YES if the action message is sent all at once when the user clicks the search button or presses return; otherwise, NO if the search string is sent after each keystroke. The default value is NO. */ - (BOOL)sendsWholeSearchString { @@ -303,7 +303,7 @@ var CPSearchFieldSearchImage = nil, /*! Sets whether the receiver sends the search action message when the user clicks the search button (or presses return) or after each keystroke. - @param flag <code>YES</code> to send the action message all at once when the user clicks the search button or presses return; otherwise, NO to send the search string after each keystroke. + @param flag \c YES to send the action message all at once when the user clicks the search button or presses return; otherwise, NO to send the search string after each keystroke. */ - (void)setSendsWholeSearchString:(BOOL)flag { @@ -312,7 +312,7 @@ var CPSearchFieldSearchImage = nil, /*! Returns a Boolean value indicating whether the receiver sends its action immediately upon being notified of changes to the search field text or after a brief pause. - @return <code>YES</code> if the text field sends its action immediately upon notification of any changes to the search field; otherwise, NO. + @return \c YES if the text field sends its action immediately upon notification of any changes to the search field; otherwise, NO. */ - (BOOL)sendsSearchStringImmediately { @@ -321,7 +321,7 @@ var CPSearchFieldSearchImage = nil, /*! Sets whether the text field sends its action message to the target immediately upon notification of any changes to the search field text or after a brief pause. - @param flag <code>YES</code> to send the text field's action immediately upon notification of any changes to the search field; otherwise, NO if you want the text field to pause briefly before sending its action message. Pausing gives the user the opportunity to type more text into the search field before initiating the search. + @param flag \c YES to send the text field's action immediately upon notification of any changes to the search field; otherwise, NO if you want the text field to pause briefly before sending its action message. Pausing gives the user the opportunity to type more text into the search field before initiating the search. */ - (void)setSendsSearchStringImmediately:(BOOL)flag { @@ -354,7 +354,7 @@ var CPSearchFieldSearchImage = nil, /*! Returns the list of recent search strings for the control. - @return An array of <code><CPString</code> objects, each of which contains a search string either displayed in the search menu or from a recent autosave archive. If there have been no recent searches and no prior searches saved under an autosave name, this array may be empty. + @return An array of \c CPString objects, each of which contains a search string either displayed in the search menu or from a recent autosave archive. If there have been no recent searches and no prior searches saved under an autosave name, this array may be empty. */ - (CPArray)recentSearches { AppKit/CPSearchField.j @@ -141,7 +141,7 @@ CPSegmentSwitchTrackingMomentary = 2; /*! Selects a segment. @param aSegment the segment to select - @throws CPRangeException if <code>aSegment</code> is out of bounds + @throws CPRangeException if \c aSegment is out of bounds */ - (void)setSelectedSegment:(unsigned)aSegment { @@ -225,7 +225,7 @@ CPSegmentSwitchTrackingMomentary = 2; Sets the width of the specified segment. @param aWidth the new width for the segment @param aSegment the segment to set the width for - @throws CPRangeException if <code>aSegment</code> is out of bounds + @throws CPRangeException if \c aSegment is out of bounds */ - (void)setWidth:(float)aWidth forSegment:(unsigned)aSegment { @@ -237,7 +237,7 @@ CPSegmentSwitchTrackingMomentary = 2; /*! Returns the width for the specified segment. @param aSegment the segment to get the width for - @throws CPRangeException if <code>aSegment</code> is out of bounds + @throws CPRangeException if \c aSegment is out of bounds */ - (float)widthForSegment:(unsigned)aSegment { @@ -248,7 +248,7 @@ CPSegmentSwitchTrackingMomentary = 2; Sets the image for the specified segment. @param anImage the image for the segment @param aSegment the segment to set the image on - @throws CPRangeException if <code>aSegment</code> is out of bounds + @throws CPRangeException if \c aSegment is out of bounds */ - (void)setImage:(CPImage)anImage forSegment:(unsigned)aSegment { @@ -262,7 +262,7 @@ CPSegmentSwitchTrackingMomentary = 2; /*! Returns the image for the specified segment @param aSegment the segment to obtain the image for - @throws CPRangeException if <code>aSegment</code> is out of bounds + @throws CPRangeException if \c aSegment is out of bounds */ - (CPImage)imageForSegment:(unsigned)aSegment { @@ -273,7 +273,7 @@ CPSegmentSwitchTrackingMomentary = 2; Sets the label for the specified segment @param aLabel the label for the segment @param aSegment the segment to label - @throws CPRangeException if <code>aSegment</code> is out of bounds + @throws CPRangeException if \c aSegment is out of bounds */ - (void)setLabel:(CPString)aLabel forSegment:(unsigned)aSegment { @@ -287,7 +287,7 @@ CPSegmentSwitchTrackingMomentary = 2; /*! Returns the label for the specified segment @param the segment to obtain the label for - @throws CPRangeException if <code>aSegment</code> is out of bounds + @throws CPRangeException if \c aSegment is out of bounds */ - (CPString)labelForSegment:(unsigned)aSegment { @@ -298,7 +298,7 @@ CPSegmentSwitchTrackingMomentary = 2; Sets the menu for the specified segment @param aMenu the menu to set @param aSegment the segment to set the menu on - @throws CPRangeException if <code>aSegment</code> is out of bounds + @throws CPRangeException if \c aSegment is out of bounds */ - (void)setMenu:(CPMenu)aMenu forSegment:(unsigned)aSegment { @@ -308,7 +308,7 @@ CPSegmentSwitchTrackingMomentary = 2; /*! Returns the menu for the specified segment. @param aSegment the segment to obtain the menu for - @throws CPRangeException if <code>aSegment</code> is out of bounds + @throws CPRangeException if \c aSegment is out of bounds */ - (CPMenu)menuForSegment:(unsigned)aSegment { @@ -318,9 +318,9 @@ CPSegmentSwitchTrackingMomentary = 2; /*! Sets the selection for the specified segment. If only one segment can be selected at a time, any other segment will be deselected. - @param isSelected <code>YES</code> selects the segment. <code>NO</code> deselects it. + @param isSelected \c YES selects the segment. \c NO deselects it. @param aSegment the segment to set the selection for - @throws CPRangeException if <code>aSegment</code> is out of bounds + @throws CPRangeException if \c aSegment is out of bounds */ - (void)setSelected:(BOOL)isSelected forSegment:(unsigned)aSegment { @@ -358,9 +358,9 @@ CPSegmentSwitchTrackingMomentary = 2; } /*! - Returns <code>YES</code> if the specified segment is selected. + Returns \c YES if the specified segment is selected. @param aSegment the segment to check for selection - @throws CPRangeException if <code>aSegment</code> is out of bounds + @throws CPRangeException if \c aSegment is out of bounds */ - (BOOL)isSelectedForSegment:(unsigned)aSegment { @@ -369,9 +369,9 @@ CPSegmentSwitchTrackingMomentary = 2; /*! Enables/diables the specified segment. - @param isEnabled <code>YES</code> enables the segment + @param isEnabled \c YES enables the segment @param aSegment the segment to enable/disble - @throws CPRangeException if <code>aSegment</code> is out of bounds + @throws CPRangeException if \c aSegment is out of bounds */ - (void)setEnabled:(BOOL)isEnabled forSegment:(unsigned)aSegment { @@ -382,9 +382,9 @@ CPSegmentSwitchTrackingMomentary = 2; } /*! - Returns <code>YES</code> if the specified segment is enabled. + Returns \c YES if the specified segment is enabled. @param aSegment the segment to check - @throws CPRangeException if <code>aSegment</code> is out of bounds + @throws CPRangeException if \c aSegment is out of bounds */ - (BOOL)isEnabledForSegment:(unsigned)aSegment { @@ -414,7 +414,7 @@ CPSegmentSwitchTrackingMomentary = 2; /*! Draws the specified segment bezel @param aSegment the segment to draw the bezel for - @param shouldHighlight <code>YES</code> highlights the bezel + @param shouldHighlight \c YES highlights the bezel */ - (void)drawSegmentBezel:(int)aSegment highlight:(BOOL)shouldHighlight { @@ -582,7 +582,7 @@ CPSegmentSwitchTrackingMomentary = 2; /*! Draws the specified segment @param aSegment the segment to draw - @param shouldHighlight <code>YES</code> highlights the bezel + @param shouldHighlight \c YES highlights the bezel */ - (void)drawSegment:(int)aSegment highlight:(BOOL)shouldHighlight { AppKit/CPSegmentedControl.j @@ -559,7 +559,7 @@ var CPSplitViewDelegateKey = "CPSplitViewDelegateKey", @implementation CPSplitView (CPCoding) /* - Initializes the split view by unarchiving data from <code>aCoder</code>. + Initializes the split view by unarchiving data from \c aCoder. @param aCoder the coder containing the archived CPSplitView. */ - (id)initWithCoder:(CPCoder)aCoder AppKit/CPSplitView.j @@ -241,7 +241,7 @@ CPTableColumnUserResizingMask; /*! Sets whether the column in this data is editable. - @param aFlag <code>YES</code> means the column data is editable + @param aFlag \c YES means the column data is editable */ - (void)setEditable:(BOOL)aFlag { @@ -249,7 +249,7 @@ CPTableColumnUserResizingMask; } /*! - Returns <code>YES</code> if the column data is editable. + Returns \c YES if the column data is editable. */ - (BOOL)isEditable { @@ -313,7 +313,7 @@ CPTableColumnUserResizingMask; } /*! - By default returns the value from <code>dataCell</code>. This can + By default returns the value from \c -dataCell. This can be overridden by a subclass to return different cells for different rows. @param aRowIndex the index of the row to obtain the cell for AppKit/CPTableColumn.j @@ -561,7 +561,7 @@ var _CPTableViewWillDisplayCellSelector = 1 << 0, - (id)tableView:(CPTableView)aTableView objectValueForTableColumn:(CPTableColumn)aTableColumn row:(int)rowIndex </pre> @param aDataSource the object with the table data - @throws CPInternalInconsistencyException if <code>aDataSource</code> doesn't implement all the required methods + @throws CPInternalInconsistencyException if \c aDataSource doesn't implement all the required methods */ - (void)setDataSource:(id)aDataSource { @@ -687,7 +687,7 @@ var _CPTableViewWillDisplayCellSelector = 1 << 0, } /* - Adjusts column widths to make them all visible at once. Same as <code>tile</code>. + Adjusts column widths to make them all visible at once. Same as \c -tile. */ - (void)sizeToFit { @@ -730,7 +730,7 @@ var _CPTableViewWillDisplayCellSelector = 1 << 0, } /* - Reloads the data from the <code>dataSource</code>. This is an + Reloads the data from the \c -dataSource. This is an expensive method, so use it lightly. */ - (void)reloadData AppKit/CPTableView.j @@ -100,7 +100,7 @@ var CPSecureTextFieldCharacter = "\u2022"; @implementation CPString (CPTextFieldAdditions) /*! - Returns the string (<code>self</code>). + Returns the string (\c self). */ - (CPString)string { @@ -389,7 +389,7 @@ CPTextFieldStatePlaceholder = CPThemeState("placeholder"); } /*! - Returns <code>YES</code> if the textfield is currently editable by the user. + Returns \c YES if the textfield is currently editable by the user. */ - (BOOL)isEditable { @@ -398,7 +398,7 @@ CPTextFieldStatePlaceholder = CPThemeState("placeholder"); /*! Sets whether the field's text is selectable by the user. - @param aFlag <code>YES</code> makes the text selectable + @param aFlag \c YES makes the text selectable */ - (void)setSelectable:(BOOL)aFlag { @@ -406,7 +406,7 @@ CPTextFieldStatePlaceholder = CPThemeState("placeholder"); } /*! - Returns <code>YES</code> if the field's text is selectable by the user. + Returns \c YES if the field's text is selectable by the user. */ - (BOOL)isSelectable { @@ -415,7 +415,7 @@ CPTextFieldStatePlaceholder = CPThemeState("placeholder"); /*! Sets whether the field's text is secure. - @param aFlag <code>YES</code> makes the text secure + @param aFlag \c YES makes the text secure */ - (void)setSecure:(BOOL)aFlag { @@ -423,7 +423,7 @@ CPTextFieldStatePlaceholder = CPThemeState("placeholder"); } /*! - Returns <code>YES</code> if the field's text is secure (password entry). + Returns \c YES if the field's text is secure (password entry). */ - (BOOL)isSecure { @@ -433,7 +433,7 @@ CPTextFieldStatePlaceholder = CPThemeState("placeholder"); // Setting the Bezel Style /*! Sets whether the textfield will have a bezeled border. - @param shouldBeBezeled <code>YES</code> means the textfield will draw a bezeled border + @param shouldBeBezeled \c YES means the textfield will draw a bezeled border */ - (void)setBezeled:(BOOL)shouldBeBezeled { @@ -444,7 +444,7 @@ CPTextFieldStatePlaceholder = CPThemeState("placeholder"); } /*! - Returns <code>YES</code> if the textfield draws a bezeled border. + Returns \c YES if the textfield draws a bezeled border. */ - (BOOL)isBezeled { @@ -478,7 +478,7 @@ CPTextFieldStatePlaceholder = CPThemeState("placeholder"); /*! Sets whether the textfield will have a border drawn. - @param shouldBeBordered <code>YES</code> makes the textfield draw a border + @param shouldBeBordered \c YES makes the textfield draw a border */ - (void)setBordered:(BOOL)shouldBeBordered { @@ -489,7 +489,7 @@ CPTextFieldStatePlaceholder = CPThemeState("placeholder"); } /*! - Returns <code>YES</code> if the textfield has a border. + Returns \c YES if the textfield has a border. */ - (BOOL)isBordered { @@ -498,7 +498,7 @@ CPTextFieldStatePlaceholder = CPThemeState("placeholder"); /*! Sets whether the textfield will have a background drawn. - @param shouldDrawBackground <code>YES</code> makes the textfield draw a background + @param shouldDrawBackground \c YES makes the textfield draw a background */ - (void)setDrawsBackground:(BOOL)shouldDrawBackground { @@ -512,7 +512,7 @@ CPTextFieldStatePlaceholder = CPThemeState("placeholder"); } /*! - Returns <code>YES</code> if the textfield draws a background. + Returns \c YES if the textfield draws a background. */ - (BOOL)drawsBackground { AppKit/CPTextField.j @@ -76,9 +76,9 @@ var CPToolbarConfigurationsByIdentifier = nil; Called to obtain a toolbar item. Required. @param toolbar the toolbar the item belongs to @param itemIdentifier the identifier of the toolbar item - @param flag <code>YES</code> means the item will be placed in the toolbar. <code>NO</code> means the item will be displayed for + @param flag \c YES means the item will be placed in the toolbar. \c NO means the item will be displayed for some other purpose (non-functional) - @return the toolbar item or <code>nil</code> if no such item belongs in the toolbar + @return the toolbar item or \c nil if no such item belongs in the toolbar */ @implementation CPToolbar : CPObject { @@ -176,7 +176,7 @@ var CPToolbarConfigurationsByIdentifier = nil; } /*! - Returns <code>YES</code> if the toolbar is currently visible + Returns \c YES if the toolbar is currently visible */ - (BOOL)isVisible { @@ -185,7 +185,7 @@ var CPToolbarConfigurationsByIdentifier = nil; /*! Sets whether the toolbar should be visible. - @param aFlag <code>YES</code> makes the toolbar visible + @param aFlag \c YES makes the toolbar visible */ - (void)setVisible:(BOOL)aFlag { @@ -304,7 +304,7 @@ var CPToolbarConfigurationsByIdentifier = nil; } /*! - Returns the toolbar items sorted by their <code>visibilityPriority</code>(ies). + Returns the toolbar items sorted by their \c visibilityPriority(ies). */ - (CPArray)itemsSortedByVisibilityPriority { @@ -369,7 +369,7 @@ var CPToolbarIdentifierKey = "CPToolbarIdentifierKey", @implementation CPToolbar (CPCoding) /* - Initializes the toolbar by unarchiving data from <code>aCoder</code>. + Initializes the toolbar by unarchiving data from \c aCoder. @param aCoder the coder containing the archived CPToolbar. */ - (id)initWithCoder:(CPCoder)aCoder AppKit/CPToolbar.j @@ -223,7 +223,7 @@ CPToolbarPrintItemIdentifier = @"CPToolbarPrintItemIdentifier"; } /*! - Sets the target of the action that is triggered when the user clicks this item. <code>nil</code> will cause + Sets the target of the action that is triggered when the user clicks this item. \c nil will cause the action to be passed on to the first responder. @param aTarget the new target */ @@ -261,7 +261,7 @@ CPToolbarPrintItemIdentifier = @"CPToolbarPrintItemIdentifier"; } /*! - Returns <code>YES</code> if the item is enabled. + Returns \c YES if the item is enabled. */ - (BOOL)isEnabled { @@ -273,7 +273,7 @@ CPToolbarPrintItemIdentifier = @"CPToolbarPrintItemIdentifier"; /*! Sets whether the item is enabled. - @param aFlag <code>YES</code> enables the item + @param aFlag \c YES enables the item */ - (void)setEnabled:(BOOL)shouldBeEnabled { AppKit/CPToolbarItem.j @@ -113,7 +113,7 @@ var DOMElementPrototype = nil, headed by the window's content view. Every other view in a window is a descendant of this view.</p> - <p>Subclasses can override <code>-drawRect:</code> in order to implement their + <p>Subclasses can override \c -drawRect: in order to implement their appearance. Other methods of CPView and CPResponder can also be overridden to handle user generated events. */ @@ -303,10 +303,10 @@ var DOMElementPrototype = nil, } /*! - Makes <code>aSubview</code> a subview of the receiver. It is positioned relative to <code>anotherView</code> + Makes \c aSubview a subview of the receiver. It is positioned relative to \c anotherView @param aSubview the view to add as a subview - @param anOrderingMode specifies <code>aSubview</code>'s ordering relative to <code>anotherView</code> - @param anotherView <code>aSubview</code> will be positioned relative to this argument + @param anOrderingMode specifies \c aSubview's ordering relative to \c anotherView + @param anotherView \c aSubview will be positioned relative to this argument */ - (void)addSubview:(CPView)aSubview positioned:(CPWindowOrderingMode)anOrderingMode relativeTo:(CPView)anotherView { @@ -394,7 +394,7 @@ var DOMElementPrototype = nil, } /*! - Called when the receiver has added <code>aSubview</code> to it's child views. + Called when the receiver has added \c aSubview to it's child views. @param aSubview the view that was added */ - (void)didAddSubview:(CPView)aSubview @@ -478,7 +478,7 @@ var DOMElementPrototype = nil, } /*! - Returns <code>YES</code> if the receiver is, or is a descendant of, <code>aView</code>. + Returns \c YES if the receiver is, or is a descendant of, \c aView. @param aView the view to test for ancestry */ - (BOOL)isDescendantOf:(CPView)aView @@ -536,7 +536,7 @@ var DOMElementPrototype = nil, /*! Returns the menu item containing the receiver or one of its ancestor views. - @return a menu item, or <code>nil</code> if the view or one of its ancestors wasn't found + @return a menu item, or \c nil if the view or one of its ancestors wasn't found */ - (CPMenuItem)enclosingMenuItem { @@ -589,7 +589,7 @@ var DOMElementPrototype = nil, /*! Returns whether the view is flipped. - @return <code>YES</code> if the view is flipped. <code>NO</code>, otherwise. + @return \c YES if the view is flipped. \c NO, otherwise. */ - (BOOL)isFlipped { @@ -685,7 +685,7 @@ var DOMElementPrototype = nil, } /*! - Sets the receiver's frame size. If <code>aSize</code> is the same as the frame's current dimensions, this + Sets the receiver's frame size. If \c aSize is the same as the frame's current dimensions, this 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 @@ -902,7 +902,7 @@ var DOMElementPrototype = nil, } /*! - Initiates <code>superviewSizeChanged:</code> messages to subviews. + Initiates \c -superviewSizeChanged: messages to subviews. @param aSize the size for the subviews */ - (void)resizeSubviewsWithOldSize:(CGSize)aSize @@ -915,9 +915,9 @@ var DOMElementPrototype = nil, /*! Specifies whether the receiver view should automatically resize its - subviews when its <code>setFrameSize:</code> method receives a change. - @param aFlag If <code>YES</code>, then subviews will automatically be resized - when this view is resized. <code>NO</code> means the views will not + subviews when its \c -setFrameSize: method receives a change. + @param aFlag If \c YES, then subviews will automatically be resized + when this view is resized. \c NO means the views will not be resized automatically. */ - (void)setAutoresizesSubviews:(BOOL)aFlag @@ -927,7 +927,7 @@ var DOMElementPrototype = nil, /*! Reports whether the receiver automatically resizes its subviews when its frame size changes. - @return <code>YES</code> means it resizes its subviews on a frame size change. + @return \c YES means it resizes its subviews on a frame size change. */ - (BOOL)autoresizesSubviews { @@ -1019,7 +1019,7 @@ var DOMElementPrototype = nil, } /*! - Returns <code>YES</code> if the receiver is currently in full screen mode. + Returns \c YES if the receiver is currently in full screen mode. */ - (BOOL)isInFullScreenMode { @@ -1028,7 +1028,7 @@ var DOMElementPrototype = nil, /*! Sets whether the receiver should be hidden. - @param aFlag <code>YES</code> makes the receiver hidden. + @param aFlag \c YES makes the receiver hidden. */ - (void)setHidden:(BOOL)aFlag { @@ -1064,7 +1064,7 @@ var DOMElementPrototype = nil, } /*! - Returns <code>YES</code> if the receiver is hidden. + Returns \c YES if the receiver is hidden. */ - (BOOL)isHidden { @@ -1108,8 +1108,8 @@ var DOMElementPrototype = nil, } /*! - Returns <code>YES</code> if the receiver is hidden, or one - of it's ancestor views is hidden. <code>NO</code>, otherwise. + Returns \c YES if the receiver is hidden, or one + of it's ancestor views is hidden. \c NO, otherwise. */ - (BOOL)isHiddenOrHasHiddenAncestor { @@ -1122,9 +1122,9 @@ var DOMElementPrototype = nil, } /*! - Returns whether the receiver should be sent a <code>mouseDown:</code> message for <code>anEvent</code>.<br/> - Returns <code>YES</code> by default. - @return <code>YES</code>, if the view object accepts first mouse-down event. <code>NO</code>, otherwise. + Returns whether the receiver should be sent a \c -mouseDown: message for \c anEvent.<br/> + Returns \c YES by default. + @return \c YES, if the view object accepts first mouse-down event. \c NO, otherwise. */ //FIXME: should be NO by default? - (BOOL)acceptsFirstMouse:(CPEvent)anEvent @@ -1134,7 +1134,7 @@ var DOMElementPrototype = nil, /*! Returns whether or not the view responds to hit tests. - @return <code>YES</code> if this view listens to hitTest messages, <code>NO</code> otherwise. + @return \c YES if this view listens to \c -hitTest messages, \c NO otherwise. */ - (BOOL)hitTests { @@ -1143,7 +1143,7 @@ var DOMElementPrototype = nil, /*! Set whether or not the view should respond to hit tests. - @param shouldHitTest should be <code>YES</code> if this view should respond to hit tests, <code>NO</code> otherwise. + @param shouldHitTest should be \c YES if this view should respond to hit tests, \c NO otherwise. */ - (void)setHitTests:(BOOL)shouldHitTest { @@ -1175,8 +1175,8 @@ var DOMElementPrototype = nil, } /*! - Returns <code>YES</code> if mouse events aren't needed by the receiver and can be sent to the superview. The - default implementation returns <code>NO</code> if the view is opaque. + Returns \c YES if mouse events aren't needed by the receiver and can be sent to the superview. The + default implementation returns \c NO if the view is opaque. */ - (BOOL)mouseDownCanMoveWindow { @@ -1314,7 +1314,7 @@ var DOMElementPrototype = nil, // Converting Coordinates /*! - Converts <code>aPoint</code> from the coordinate space of <code>aView</code> to the coordinate space of the receiver. + Converts \c aPoint from the coordinate space of \c aView to the coordinate space of the receiver. @param aPoint the point to convert @param aView the view space to convert from @return the converted point @@ -1325,7 +1325,7 @@ var DOMElementPrototype = nil, } /*! - Converts <code>aPoint</code> from the receiver's coordinate space to the coordinate space of <code>aView</code>. + Converts \c aPoint from the receiver's coordinate space to the coordinate space of \c aView. @param aPoint the point to convert @param aView the coordinate space to which the point will be converted @return the converted point @@ -1336,7 +1336,7 @@ var DOMElementPrototype = nil, } /*! - Convert's <code>aSize</code> from <code>aView</code>'s coordinate space to the receiver's coordinate space. + Convert's \c aSize from \c aView's coordinate space to the receiver's coordinate space. @param aSize the size to convert @param aView the coordinate space to convert from @return the converted size @@ -1347,7 +1347,7 @@ var DOMElementPrototype = nil, } /*! - Convert's <code>aSize</code> from the receiver's coordinate space to <code>aView</code>'s coordinate space. + Convert's \c aSize from the receiver's coordinate space to \c aView's coordinate space. @param aSize the size to convert @param the coordinate space to which the size will be converted @return the converted size @@ -1358,7 +1358,7 @@ var DOMElementPrototype = nil, } /*! - Converts <code>aRect</code> from <code>aView</code>'s coordinate space to the receiver's space. + Converts \c aRect from \c aView's coordinate space to the receiver's space. @param aRect the rectangle to convert @param aView the coordinate space from which to convert @return the converted rectangle @@ -1369,7 +1369,7 @@ var DOMElementPrototype = nil, } /*! - Converts <code>aRect</code> from the receiver's coordinate space to <code>aView</code>'s coordinate space. + Converts \c aRect from the receiver's coordinate space to \c aView's coordinate space. @param aRect the rectangle to convert @param aView the coordinate space to which the rectangle will be converted @return the converted rectangle @@ -1381,14 +1381,14 @@ var DOMElementPrototype = nil, /*! Sets whether the receiver posts a CPViewFrameDidChangeNotification notification - to the default notification center when its frame is changed. The default is <code>NO</code>. + to the default notification center when its frame is changed. The default is \c NO. Methods that could cause a frame change notification are: <pre> setFrame: setFrameSize: setFrameOrigin: </pre> - @param shouldPostFrameChangedNotifications <code>YES</code> makes the receiver post + @param shouldPostFrameChangedNotifications \c YES makes the receiver post notifications on frame changes (size or origin) */ - (void)setPostsFrameChangedNotifications:(BOOL)shouldPostFrameChangedNotifications @@ -1405,7 +1405,7 @@ setFrameOrigin: } /*! - Returns <code>YES</code> if the receiver posts a CPViewFrameDidChangeNotification if its frame is changed. + Returns \c YES if the receiver posts a CPViewFrameDidChangeNotification if its frame is changed. */ - (BOOL)postsFrameChangedNotifications { @@ -1414,14 +1414,14 @@ setFrameOrigin: /*! Sets whether the receiver posts a CPViewBoundsDidChangeNotification notification - to the default notification center when its bounds is changed. The default is <code>NO</code>. + to the default notification center when its bounds is changed. The default is \c NO. Methods that could cause a bounds change notification are: <pre> setBounds: setBoundsSize: setBoundsOrigin: </pre> - @param shouldPostBoundsChangedNotifications <code>YES</code> makes the receiver post + @param shouldPostBoundsChangedNotifications \c YES makes the receiver post notifications on bounds changes */ - (void)setPostsBoundsChangedNotifications:(BOOL)shouldPostBoundsChangedNotifications @@ -1438,7 +1438,7 @@ setBoundsOrigin: } /*! - Returns <code>YES</code> if the receiver posts a + Returns \c YES if the receiver posts a CPViewBoundsDidChangeNotification when its bounds is changed. */ @@ -1450,9 +1450,9 @@ setBoundsOrigin: /*! Initiates a drag operation from the receiver to another view that accepts dragged data. @param anImage the image to be dragged - @param aLocation the lower-left corner coordinate of <code>anImage</code> - @param mouseOffset the distance from the <code>mouseDown:</code> location and the current location - @param anEvent the <code>mouseDown:</code> that triggered the drag + @param aLocation the lower-left corner coordinate of \c anImage + @param mouseOffset the distance from the \c -mouseDown: location and the current location + @param anEvent the \c -mouseDown: that triggered the drag @param aPastebaord the pasteboard that holds the drag data @param aSourceObject the drag operation controller @param slideBack Whether the image should 'slide back' if the drag is rejected @@ -1465,9 +1465,9 @@ setBoundsOrigin: /*! Initiates a drag operation from the receiver to another view that accepts dragged data. @param aView the view to be dragged - @param aLocation the top-left corner coordinate of <code>aView</code> - @param mouseOffset the distance from the <code>mouseDown:</code> location and the current location - @param anEvent the <code>mouseDown:</code> that triggered the drag + @param aLocation the top-left corner coordinate of \c aView + @param mouseOffset the distance from the \c -mouseDown: location and the current location + @param anEvent the \c -mouseDown: that triggered the drag @param aPastebaord the pasteboard that holds the drag data @param aSourceObject the drag operation controller @param slideBack Whether the view should 'slide back' if the drag is rejected @@ -1519,7 +1519,7 @@ setBoundsOrigin: } /*! - Draws the receiver into <code>aRect</code>. This method should be overridden by subclasses. + Draws the receiver into \c aRect. This method should be overridden by subclasses. @param aRect the area that should be drawn into */ - (void)drawRect:(CPRect)aRect @@ -1543,7 +1543,7 @@ setBoundsOrigin: } /*! - Marks the area denoted by <code>aRect</code> as dirty, and initiates a redraw on it. + Marks the area denoted by \c aRect as dirty, and initiates a redraw on it. @param aRect the area that needs to be redrawn */ - (void)setNeedsDisplayInRect:(CPRect)aRect @@ -1590,7 +1590,7 @@ setBoundsOrigin: } /*! - Draws the entire area of the receiver as defined by its <code>bounds</code>. + Draws the entire area of the receiver as defined by its \c -bounds. */ - (void)display { @@ -1604,7 +1604,7 @@ setBoundsOrigin: } /*! - Draws the receiver into the area defined by <code>aRect</code>. + Draws the receiver into the area defined by \c aRect. @param aRect the area to be drawn */ - (void)displayRect:(CPRect)aRect @@ -1714,7 +1714,7 @@ setBoundsOrigin: } /*! - Returns whether the receiver is completely opaque. By default, returns <code>NO</code>. + Returns whether the receiver is completely opaque. By default, returns \c NO. */ - (BOOL)isOpaque { @@ -1746,7 +1746,7 @@ setBoundsOrigin: } /*! - Changes the receiver's frame origin to a 'constrained' <code>aPoint</code>. + Changes the receiver's frame origin to a 'constrained' \c aPoint. @param aPoint the proposed frame origin */ - (void)scrollPoint:(CGPoint)aPoint @@ -1760,9 +1760,9 @@ setBoundsOrigin: } /*! - Scrolls the nearest ancestor CPClipView a minimum amount so <code>aRect</code> can become visible. + Scrolls the nearest ancestor CPClipView a minimum amount so \c aRect can become visible. @param aRect the area to become visible - @return <codeYES</code> if any scrolling occurred, <code>NO</code> otherwise. + @return <codeYES if any scrolling occurred, \c NO otherwise. */ - (BOOL)scrollRectToVisible:(CGRect)aRect { @@ -1956,7 +1956,7 @@ setBoundsOrigin: /*! Sets whether the receiver wants a core animation layer. - @param <code>YES</code> means the receiver wants a layer. + @param \c YES means the receiver wants a layer. */ - (void)setWantsLayer:(BOOL)aFlag { @@ -1964,8 +1964,8 @@ setBoundsOrigin: } /*! - Returns <code>YES</code> if the receiver uses a CALayer - @returns <code>YES</code> if the receiver uses a CALayer + Returns \c YES if the receiver uses a CALayer + @returns \c YES if the receiver uses a CALayer */ - (BOOL)wantsLayer { AppKit/CPView.j @@ -231,7 +231,7 @@ var CPWindowSaveImage = nil, @delegate -(BOOL)windowShouldClose:(id)window; Called when the user tries to close the window. @param window the window to close - @return <code>YES</code> allows the window to close. <code>NO</code> + @return \c YES allows the window to close. \c NO vetoes the close operation and leaves the window open. */ @implementation CPWindow : CPResponder @@ -675,7 +675,7 @@ CPTexturedBackgroundWindowMask /*! Relocates the window in the screen list. - @param aPlace the positioning relative to <code>otherWindowNumber</code> + @param aPlace the positioning relative to \c otherWindowNumber @param otherWindowNumber the window relative to which the receiver should be placed */ - (void)orderWindow:(CPWindowOrderingMode)aPlace relativeTo:(int)otherWindowNumber @@ -701,7 +701,7 @@ CPTexturedBackgroundWindowMask } /*! - Returns <code>YES</code> if the window is visible. It does not mean that the window is not obscured by other windows. + Returns \c YES if the window is visible. It does not mean that the window is not obscured by other windows. */ - (BOOL)isVisible { @@ -709,7 +709,7 @@ CPTexturedBackgroundWindowMask } /*! - Returns <code>YES</code> if the window's resize indicator is showing. <code>NO</code> otherwise. + Returns \c YES if the window's resize indicator is showing. \c NO otherwise. */ - (BOOL)showsResizeIndicator { @@ -718,7 +718,7 @@ CPTexturedBackgroundWindowMask /*! Sets the window's resize indicator. - @param shouldShowResizeIndicator <code>YES</code> sets the window to show its resize indicator. + @param shouldShowResizeIndicator \c YES sets the window to show its resize indicator. */ - (void)setShowsResizeIndicator:(BOOL)shouldShowResizeIndicator { @@ -866,7 +866,7 @@ CPTexturedBackgroundWindowMask } /*! - Returns <code>YES</code> if the window has a drop shadow. <code>NO</code> otherwise. + Returns \c YES if the window has a drop shadow. \c NO otherwise. */ - (BOOL)hasShadow { @@ -875,7 +875,7 @@ CPTexturedBackgroundWindowMask /*! Sets whether the window should have a drop shadow. - @param shouldHaveShadow <code>YES</code> to have a drop shadow. + @param shouldHaveShadow \c YES to have a drop shadow. */ - (void)setHasShadow:(BOOL)shouldHaveShadow { @@ -928,7 +928,7 @@ CPTexturedBackgroundWindowMask } /*! - Sets the delegate for the window. Passing <code>nil</code> will just remove the window's current delegate. + Sets the delegate for the window. Passing \c nil will just remove the window's current delegate. @param aDelegate an object to respond to the various delegate methods of CPWindow */ - (void)setDelegate:(id)aDelegate @@ -1002,11 +1002,11 @@ CPTexturedBackgroundWindowMask } /*! - Attempts to make the <code>aResponder</code> the first responder. Before trying + Attempts to make the \c aResponder the first responder. Before trying to make it the first responder, the receiver will ask the current first responder to resign its first responder status. If it resigns, it will ask - <code>aResponder</code> accept first responder, then finally tell it to become first responder. - @return <code>YES</code> if the attempt was successful. <code>NO</code> otherwise. + \c aResponder accept first responder, then finally tell it to become first responder. + @return \c YES if the attempt was successful. \c NO otherwise. */ - (void)makeFirstResponder:(CPResponder)aResponder { @@ -1124,7 +1124,7 @@ CPTexturedBackgroundWindowMask /*! Sets whether the window can be moved by dragging its background. The default is based on the window style. - @param shouldBeMovableByWindowBackground <code>YES</code> makes the window move from a background drag. + @param shouldBeMovableByWindowBackground \c YES makes the window move from a background drag. */ - (void)setMovableByWindowBackground:(BOOL)shouldBeMovableByWindowBackground { @@ -1132,7 +1132,7 @@ CPTexturedBackgroundWindowMask } /*! - Returns <code>YES</code> if the window can be moved by dragging its background. + Returns \c YES if the window can be moved by dragging its background. */ - (BOOL)isMovableByWindowBackground { @@ -1267,7 +1267,7 @@ CPTexturedBackgroundWindowMask /*! Called when the receiver should become the key window. It also sends - the <code>becomeKeyWindow</code> message to the first responder. + the \c -becomeKeyWindow message to the first responder. */ - (void)becomeKeyWindow { @@ -1277,7 +1277,7 @@ CPTexturedBackgroundWindowMask /*! Determines if the window can become the key window. - @return <code>YES</code> means the window can become the key window. + @return \c YES means the window can become the key window. */ - (BOOL)canBecomeKeyWindow { @@ -1285,7 +1285,7 @@ CPTexturedBackgroundWindowMask } /*! - Returns <code>YES</code> if the window is the key window. + Returns \c YES if the window is the key window. */ - (BOOL)isKeyWindow { @@ -1334,9 +1334,9 @@ CPTexturedBackgroundWindowMask /*! Initiates a drag operation from the receiver to another view that accepts dragged data. @param anImage the image to be dragged - @param aLocation the lower-left corner coordinate of <code>anImage</code> - @param mouseOffset the distance from the <code>mouseDown:</code> location and the current location - @param anEvent the <code>mouseDown:</code> that triggered the drag + @param aLocation the lower-left corner coordinate of \c anImage + @param mouseOffset the distance from the \c -mouseDown: location and the current location + @param anEvent the \c -mouseDown: that triggered the drag @param aPastebaord the pasteboard that holds the drag data @param aSourceObject the drag operation controller @param slideBack Whether the image should 'slide back' if the drag is rejected @@ -1371,9 +1371,9 @@ CPTexturedBackgroundWindowMask /*! Initiates a drag operation from the receiver to another view that accepts dragged data. @param aView the view to be dragged - @param aLocation the lower-left corner coordinate of <code>aView</code> - @param mouseOffset the distance from the <code>mouseDown:</code> location and the current location - @param anEvent the <code>mouseDown:</code> that triggered the drag + @param aLocation the lower-left corner coordinate of \c aView + @param mouseOffset the distance from the \c -mouseDown: location and the current location + @param anEvent the \c -mouseDown: that triggered the drag @param aPastebaord the pasteboard that holds the drag data @param aSourceObject the drag operation controller @param slideBack Whether the view should 'slide back' if the drag is rejected @@ -1426,7 +1426,7 @@ CPTexturedBackgroundWindowMask /*! Sets whether the document has been edited. - @param isDocumentEdited <code>YES</code> if the document has been edited. + @param isDocumentEdited \c YES if the document has been edited. */ - (void)setDocumentEdited:(BOOL)isDocumentEdited { @@ -1439,7 +1439,7 @@ CPTexturedBackgroundWindowMask } /*! - Returns <code>YES</code> if the document has been edited. + Returns \c YES if the document has been edited. */ - (BOOL)isDocumentEdited { @@ -1516,7 +1516,7 @@ CPTexturedBackgroundWindowMask } /*! - Closes the window. Posts a <code>CPWindowWillCloseNotification</code> to the + Closes the window. Posts a \c CPWindowWillCloseNotification to the notification center before closing the window. */ - (void)close @@ -1528,7 +1528,7 @@ CPTexturedBackgroundWindowMask // Managing Main Status /*! - Returns <code>YES</code> if this the main window. + Returns \c YES if this the main window. */ - (BOOL)isMainWindow { @@ -1536,7 +1536,7 @@ CPTexturedBackgroundWindowMask } /*! - Returns <code>YES</code> if the window can become the main window. + Returns \c YES if the window can become the main window. */ - (BOOL)canBecomeMainWindow { @@ -1711,7 +1711,7 @@ CPTexturedBackgroundWindowMask } /*! - Returns <code>YES</code> if the window has ever run as a sheet. + Returns \c YES if the window has ever run as a sheet. */ - (BOOL)isSheet { @@ -1729,7 +1729,7 @@ CPTexturedBackgroundWindowMask } /*! - Returns <code>YES</code> if the receiver is able to receive input events + Returns \c YES if the receiver is able to receive input events even when a modal session is active. */ - (BOOL)worksWhenModal @@ -2003,7 +2003,7 @@ var keyViewComparator = function(a, b, context) } /*! - Sends the undo manager an <code>undo</code> message. + Sends the undo manager an \c -undo: message. @param aSender the object requesting this */ - (void)undo:(id)aSender @@ -2012,7 +2012,7 @@ var keyViewComparator = function(a, b, context) } /*! - Sends the undo manager a <code>redo:</code> message. + Sends the undo manager a \c -redo: message. @param aSender the object requesting this */ - (void)redo:(id)aSender AppKit/CPWindow/CPWindow.j @@ -181,7 +181,7 @@ } /*! - Returns <code>YES</code> if the window has been loaded. Specifically, + Returns \c YES if the window has been loaded. Specifically, if loadWindow has been called. */ - (BOOL)isWindowLoaded @@ -316,7 +316,7 @@ /*! Sets whether the document has unsaved changes. The window can use this as a hint to - @param isEdited <code>YES</code> means the document has unsaved changes. + @param isEdited \c YES means the document has unsaved changes. */ - (void)setDocumentEdited:(BOOL)isEdited { AppKit/CPWindowController.j @@ -54,8 +54,8 @@ } /*! - Returns <code>YES</code> - @return <code>YES</code> + Returns \c YES + @return \c YES */ - (void)shouldArchiveValueForKey:(CPString)aKey { @@ -63,8 +63,8 @@ } /*! - Returns <code>nil</code> - @return <code>nil</code> + Returns \c nil + @return \c nil */ + (id)defaultValueForKey:(CPString)aKey { @@ -73,7 +73,7 @@ /*! Specifies whether this animation should be removed after it has completed. - @param <code>YES</code> means the animation should be removed + @param \c YES means the animation should be removed */ - (void)setRemovedOnCompletion:(BOOL)isRemovedOnCompletion { @@ -81,7 +81,7 @@ } /*! - Returns <code>YES</code> if the animation is removed after completion + Returns \c YES if the animation is removed after completion */ - (BOOL)removedOnCompletion { @@ -89,7 +89,7 @@ } /*! - Returns <code>YES</code> if the animation is removed after completion + Returns \c YES if the animation is removed after completion */ - (BOOL)isRemovedOnCompletion { @@ -97,7 +97,7 @@ } /*! - Returns the animation's timing function. If <code>nil</code>, then it has a linear pacing. + Returns the animation's timing function. If \c nil, then it has a linear pacing. */ - (CAMediaTimingFunction)timingFunction { AppKit/CoreAnimation/CAAnimation.j @@ -56,12 +56,12 @@ var CALayerRegisteredRunLoopUpdates = nil; @delegate -(void)drawLayer:(CALayer)layer inContext:(CGContextRef)ctx; If the delegate implements this method, the CALayer will - call this in place of its <code>drawInContext:</code>. + call this in place of its \c -drawInContext:. @param layer the layer to draw for @param ctx the context to draw on @delegate -(void)displayLayer:(CALayer)layer; - The delegate can override the layer's <code>display</code> method + The delegate can override the layer's \c -display method by implementing this method. */ @implementation CALayer : CPObject @@ -419,7 +419,7 @@ var CALayerRegisteredRunLoopUpdates = nil; // Providing Layer Content /*! Returns the CGImage contents of this layer. - The default contents are <code>nil</code>. + The default contents are \c nil. */ - (CGImage)contents { @@ -547,7 +547,7 @@ var CALayerRegisteredRunLoopUpdates = nil; // Style Attributes /*! Returns the opacity of the layer. The value is between - <code>0.0</code> (transparent) and <code>1.0</code> (opaque). + \c 0.0 (transparent) and \c 1.0 (opaque). */ - (float)opacity { @@ -556,7 +556,7 @@ var CALayerRegisteredRunLoopUpdates = nil; /*! Sets the opacity for the layer. - @param anOpacity the new opacity (between <code>0.0</code> (transparent) and <code>1.0</code> (opaque)). + @param anOpacity the new opacity (between \c 0.0 (transparent) and \c 1.0 (opaque)). */ - (void)setOpacity:(float)anOpacity { @@ -571,7 +571,7 @@ var CALayerRegisteredRunLoopUpdates = nil; /*! Sets whether the layer is hidden. - @param isHidden <code>YES</code> means the layer will be hidden. <code>NO</code> means the layer will be visible. + @param isHidden \c YES means the layer will be hidden. \c NO means the layer will be visible. */ - (void)setHidden:(BOOL)isHidden { @@ -580,7 +580,7 @@ var CALayerRegisteredRunLoopUpdates = nil; } /*! - Returns <code>YES</code> if the layer is hidden. + Returns \c YES if the layer is hidden. */ - (BOOL)hidden { @@ -588,7 +588,7 @@ var CALayerRegisteredRunLoopUpdates = nil; } /*! - Returns <code>YES</code> if the layer is hidden. + Returns \c YES if the layer is hidden. */ - (BOOL)isHidden { @@ -597,7 +597,7 @@ var CALayerRegisteredRunLoopUpdates = nil; /*! Sets whether content that goes lies outside the bounds is hidden or visible. - @param masksToBounds <code>YES</code> hides the excess content. <code>NO</code> makes it visible. + @param masksToBounds \c YES hides the excess content. \c NO makes it visible. */ - (void)setMasksToBounds:(BOOL)masksToBounds { @@ -724,7 +724,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex) Inserts a layer below another layer. @param aLayer the layer to insert @param aSublayer the layer to insert below - @throws CALayerNotFoundException if <code>aSublayer</code> is not in the array of sublayers + @throws CALayerNotFoundException if \c aSublayer is not in the array of sublayers */ - (void)insertSublayer:(CALayer)aLayer below:(CALayer)aSublayer { @@ -737,7 +737,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex) Inserts a layer above another layer. @param aLayer the layer to insert @param aSublayer the layer to insert above - @throws CALayerNotFoundException if <code>aSublayer</code> is not in the array of sublayers + @throws CALayerNotFoundException if \c aSublayer is not in the array of sublayers */ - (void)insertSublayer:(CALayer)aLayer above:(CALayer)aSublayer { @@ -834,7 +834,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex) /*! Sets whether the layer needs to be redrawn when its bounds are changed. - @param needsDisplayOnBoundsChange <code>YES</code> means the display is redraw on a bounds change. + @param needsDisplayOnBoundsChange \c YES means the display is redraw on a bounds change. */ - (void)setNeedsDisplayOnBoundsChange:(BOOL)needsDisplayOnBoundsChange { @@ -842,7 +842,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex) } /*! - Returns <code>YES</code> if the display should be redrawn on a bounds change. + Returns \c YES if the display should be redrawn on a bounds change. */ - (BOOL)needsDisplayOnBoundsChange { @@ -906,7 +906,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex) // Hit Testing /*! - Returns <code>YES</code> if the layer contains the point. + Returns \c YES if the layer contains the point. @param aPoint the point to test */ - (BOOL)containsPoint:(CGPoint)aPoint @@ -917,7 +917,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex) /*! Returns the farthest descendant of this layer that contains the specified point. @param aPoint the point to test - @return the containing layer or <code>nil</code> if there was no hit. + @return the containing layer or \c nil if there was no hit. */ - (CALayer)hitTest:(CGPoint)aPoint { AppKit/CoreAnimation/CALayer.j @@ -101,8 +101,8 @@ function CGColorCreateCopy(aColor) /*! Creates a gray color object. - @param gray the value to use for the color intensities (<code>0.0-1.0</code>) - @param alpha the gray's alpha value (<code>0.0-1.0</code>) + @param gray the value to use for the color intensities (\c 0.\c 0-\c 1.\c 0). + @param alpha the gray's alpha value (\c 0.\c 0-\c 1.\c 0). @return CGColor the new gray color object @group CGColor */ @@ -113,10 +113,10 @@ function CGColorCreateGenericGray(gray, alpha) /*! Creates an RGB color. - @param red the red component (<code>0.0-1.0</code>) - @param green the green component (<code>0.0-1.0</code>) - @param blue the blue component (<code>0.0-1.0</code>) - @param alpha the alpha component (<code>0.0-1.0</code>) + @param red the red component (\c 0.\c 0-\c 1.\c 0).. + @param green the green component (\c 0.\c 0-\c 1.\c 0). + @param blue the blue component (\c 0.\c 0-\c 1.\c 0). + @param alpha the alpha component (\c 0.\c 0-\c 1.\c 0). @return CGColor the RGB based color @group CGColor */ @@ -127,11 +127,11 @@ function CGColorCreateGenericRGB(red, green, blue, alpha) /*! Creates a CMYK color. - @param cyan the cyan component (<code>0.0-1.0</code>) - @param magenta the magenta component (<code>0.0-1.0</code>) - @param yellow the yellow component (<code>0.0-1.0</code>) - @param black the black component (<code>0.0-1.0</code>) - @param alpha the alpha component (<code>0.0-1.0</code>) + @param cyan the cyan component (\c 0.\c 0-\c 1.\c 0). + @param magenta the magenta component (\c 0.\c 0-\c 1.\c 0). + @param yellow the yellow component (\c 0.\c 0-\c 1.\c 0). + @param black the black component (\c 0.\c 0-\c 1.\c 0). + @param alpha the alpha component (\c 0.\c 0-\c 1.\c 0). @return CGColor the CMYK based color @group CGColor */ @@ -143,7 +143,7 @@ function CGColorCreateGenericCMYK(cyan, magenta, yellow, black, alpha) /*! Creates a copy of the color with a specified alpha. @param aColor the color object to copy - @param anAlpha the new alpha component for the copy (<code>0.0-1.0</code>) + @param anAlpha the new alpha component for the copy (\c 0.\c 0-\c 1.\c 0). @return CGColor the new copy @group CGColor */ @@ -184,8 +184,8 @@ function CGColorCreateWithPattern(aColorSpace, aPattern, components) Determines if two colors are the same. @param lhs the first CGColor @param rhs the second CGColor - @return <code>YES</code> if the two colors are equal. - <code>NO</code> otherwise. + @return \c YES if the two colors are equal. + \c NO otherwise. */ function CGColorEqualToColor(lhs, rhs) { @@ -218,7 +218,7 @@ function CGColorEqualToColor(lhs, rhs) /*! Returns the color's alpha component. @param aColor the color - @return float the alpha component (<code>0.0-1.0</code>) + @return float the alpha component (\c 0.\c 0-\c 1.\c 0). @group CGColor */ function CGColorGetAlpha(aColor) AppKit/CoreGraphics/CGColor.j @@ -652,10 +652,10 @@ function CGContextSetStrokeColor(aContext, aColor) @param aContext the CGContext to draw into @param aRect the base rectangle @param aRadius the distance from the rectange corner to the rounded corner - @param ne set it to <code>YES</code> for a rounded northeast corner - @param se set it to <code>YES</code> for a rounded southeast corner - @param sw set it to <code>YES</code> for a rounded southwest corner - @param nw set it to <code>YES</code> for a rounded northwest corner + @param ne set it to \c YES for a rounded northeast corner + @param se set it to \c YES for a rounded southeast corner + @param sw set it to \c YES for a rounded southwest corner + @param nw set it to \c YES for a rounded northwest corner @return void */ function CGContextFillRoundedRectangleInRect(aContext, aRect, aRadius, ne, se, sw, nw) @@ -671,10 +671,10 @@ function CGContextFillRoundedRectangleInRect(aContext, aRect, aRadius, ne, se, s @param aContext the CGContext to draw into @param aRect the base rectangle @param aRadius the distance from the rectange corner to the rounded corner - @param ne set it to <code>YES</code> for a rounded northeast corner - @param se set it to <code>YES</code> for a rounded southeast corner - @param sw set it to <code>YES</code> for a rounded southwest corner - @param nw set it to <code>YES</code> for a rounded northwest corner + @param ne set it to \c YES for a rounded northeast corner + @param se set it to \c YES for a rounded southeast corner + @param sw set it to \c YES for a rounded southwest corner + @param nw set it to \c YES for a rounded northwest corner @return void */ function CGContextStrokeRoundedRectangleInRect(aContext, aRect, aRadius, ne, se, sw, nw) AppKit/CoreGraphics/CGContext.j @@ -76,12 +76,12 @@ _function(CGInsetIsEmpty(anInset)) */ /*! - Returns a <code>BOOL</code> indicating whether CGRect <code>lhsRect</code> - contains CGRect <code>rhsRect</code>. + Returns a \c BOOL indicating whether CGRect \c lhsRect + contains CGRect \c rhsRect. @group CGRect - @param lhsRect the CGRect to test if <code>rhsRect</code> is inside of - @param rhsRect the CGRect to test if it fits inside <code>lhsRect</code>. - @return BOOL <code>YES</code> if <code>rhsRect</code> fits inside <code>lhsRect</code>. + @param lhsRect the CGRect to test if \c rhsRect is inside of + @param rhsRect the CGRect to test if it fits inside \c lhsRect. + @return BOOL \c YES if \c rhsRect fits inside \c lhsRect. */ function CGRectContainsRect(lhsRect, rhsRect) { @@ -91,11 +91,11 @@ function CGRectContainsRect(lhsRect, rhsRect) } /*! - Returns <code>YES</code> if the two rectangles intersect + Returns \c YES if the two rectangles intersect @group CGRect @param lhsRect the first CGRect @param rhsRect the second CGRect - @return BOOL <code>YES</code> if the two rectangles have any common spaces, and <code>NO</code>, otherwise. + @return BOOL \c YES if the two rectangles have any common spaces, and \c NO, otherwise. */ function CGRectIntersectsRect(lhsRect, rhsRect) { AppKit/CoreGraphics/CGGeometry.j @@ -117,7 +117,7 @@ } /*! - Creates a new array containing the objects in <code>anArray</code>. + Creates a new array containing the objects in \c anArray. @param anArray Objects in this array will be added to the new array @return a new CPArray of the provided objects */ @@ -127,7 +127,7 @@ } /*! - Creates a new array with <code>anObject</code> in it. + Creates a new array with \c anObject in it. @param anObject the object to be added to the array @return a new CPArray containing a single object */ @@ -175,9 +175,9 @@ // Creating an Array /*! - Creates a new CPArray from <code>anArray</code>. + Creates a new CPArray from \c anArray. @param anArray objects in this array will be added to the new array - @return a new CPArray containing the objects of <code>anArray</code> + @return a new CPArray containing the objects of \c anArray */ - (id)initWithArray:(CPArray)anArray { @@ -190,10 +190,10 @@ } /*! - Initializes a the array with the contents of <code>anArray</code> - and optionally performs a deep copy of the objects based on <code>copyItems</code>. + Initializes a the array with the contents of \c anArray + and optionally performs a deep copy of the objects based on \c copyItems. @param anArray the array to copy the data from - @param copyItems if <code>YES</code>, each object will be copied by having a <code>copy</code> message sent to it, and the + @param copyItems if \c YES, each object will be copied by having a \c -copy message sent to it, and the returned object will be added to the receiver. Otherwise, no copying will be performed. @return the initialized array of objects */ @@ -240,7 +240,7 @@ /*! Initializes the array with a JavaScript array of objects. @param objects the array of objects to add to the receiver - @param aCount the number of objects in <code>objects</code> + @param aCount the number of objects in \c objects @return the initialized CPArray */ - (id)initWithObjects:(id)objects count:(unsigned)aCount @@ -260,7 +260,7 @@ // Querying an array /*! - Returns <code>YES</code> if the array contains <code>anObject</code>. Otherwise, it returns <code>NO</code>. + Returns \c YES if the array contains \c anObject. Otherwise, it returns \c NO. @param anObject the method checks if this object is already in the array */ - (BOOL)containsObject:(id)anObject @@ -277,10 +277,10 @@ } /*! - Returns the index of <code>anObject</code> in this array. - If the object is <code>nil</code> or not in the array, - returns <code>CPNotFound</code>. It first attempts to find - a match using <code>isEqual:</code>, then <code>==</code>. + Returns the index of \c anObject in this array. + If the object is \c nil or not in the array, + returns \c CPNotFound. It first attempts to find + a match using \c -isEqual:, then \c ==. @param anObject the object to search for */ - (int)indexOfObject:(id)anObject @@ -291,7 +291,7 @@ var i = 0, count = length; - // Only use isEqual: if our object is a CPObject. + // Only use -isEqual: if our object is a CPObject. if (anObject.isa) { for(; i < count; ++i) @@ -312,12 +312,12 @@ } /*! - Returns the index of <code>anObject</code> in the array - within <code>aRange</code>. It first attempts to find - a match using <code>isEqual:</code>, then <code>==</code>. + Returns the index of \c anObject in the array + within \c aRange. It first attempts to find + a match using \c -isEqual:, then \c ==. @param anObject the object to search for @param aRange the range to search within - @return the index of the object, or <code>CPNotFound</code> if it was not found. + @return the index of the object, or \c CPNotFound if it was not found. */ - (int)indexOfObject:(id)anObject inRange:(CPRange)aRange { @@ -344,9 +344,9 @@ } /*! - Returns the index of <code>anObject</code> in the array. The test for equality is done using only <code>==</code>. + Returns the index of \c anObject in the array. The test for equality is done using only \c ==. @param anObject the object to search for - @return the index of the object in the array. <code>CPNotFound</code> if the object is not in the array. + @return the index of the object in the array. \c CPNotFound if the object is not in the array. */ - (int)indexOfObjectIdenticalTo:(id)anObject { @@ -373,12 +373,12 @@ } /*! - Returns the index of <code>anObject</code> in the array - within <code>aRange</code>. The test for equality is - done using only <code>==</code>. + Returns the index of \c anObject in the array + within \c aRange. The test for equality is + done using only \c ==. @param anObject the object to search for @param aRange the range to search within - @return the index of the object, or <code>CPNotFound</code> if it was not found. + @return the index of the object, or \c CPNotFound if it was not found. */ - (int)indexOfObjectIdenticalTo:(id)anObject inRange:(CPRange)aRange { @@ -410,12 +410,12 @@ } /*! - Returns the index of <code>anObject</code> in the array, which must be sorted in the same order as + Returns the index of \c anObject in the array, which must be sorted in the same order as calling sortUsingSelector: with the selector passed to this method would result in. @param anObject the object to search for @param aSelector the comparison selector to call on each item in the list, the same selector should have been used to sort the array (or to maintain its sorted order). - @return the index of the object, or <code>CPNotFound</code> if it was not found. + @return the index of the object, or \c CPNotFound if it was not found. */ - (unsigned)indexOfObject:(id)anObject sortedBySelector:(SEL)aSelector { @@ -423,7 +423,7 @@ } /*! - Returns the index of <code>anObject</code> in the array, which must be sorted in the same order as + Returns the index of \c anObject in the array, which must be sorted in the same order as calling sortUsingFunction: with the selector passed to this method would result in. The function will be called like so: <pre> @@ -432,7 +432,7 @@ @param anObject the object to search for @param aFunction the comparison function to call on each item in the array that we search. the same selector should have been used to sort the array (or to maintain its sorted order). - @return the index of the object, or <code>CPNotFound</code> if it was not found. + @return the index of the object, or \c CPNotFound if it was not found. */ - (unsigned)indexOfObject:(id)anObject sortedByFunction:(Function)aFunction { @@ -440,7 +440,7 @@ } /*! - Returns the index of <code>anObject</code> in the array, which must be sorted in the same order as + Returns the index of \c anObject in the array, which must be sorted in the same order as calling sortUsingFunction: with the selector passed to this method would result in. The function will be called like so: <pre> @@ -450,7 +450,7 @@ @param aFunction the comparison function to call on each item in the array that we search. the same function should have been used to sort the array (or to maintain its sorted order). @param aContext a context object that will be passed to the sort function - @return the index of the object, or <code>CPNotFound</code> if it was not found. + @return the index of the object, or \c CPNotFound if it was not found. */ - (unsigned)indexOfObject:(id)anObject sortedByFunction:(Function)aFunction context:(id)aContext { @@ -480,12 +480,12 @@ } /*! - Returns the index of <code>anObject</code> in the array, which must be sorted in the same order as + Returns the index of \c anObject in the array, which must be sorted in the same order as calling sortUsingDescriptors: with the descriptors passed to this method would result in. @param anObject the object to search for @param descriptors the array of descriptors to use to compare each item in the array that we search. the same descriptors should have been used to sort the array (or to maintain its sorted order). - @return the index of the object, or <code>CPNotFound</code> if it was not found. + @return the index of the object, or \c CPNotFound if it was not found. */ - (unsigned)indexOfObject:(id)anObject sortedByDescriptors:(CPArray)descriptors { @@ -504,7 +504,7 @@ } /*! - Returns the last object in the array. If the array is empty, returns <code>nil</code>/ + Returns the last object in the array. If the array is empty, returns \c nil/ */ - (id)lastObject { @@ -516,8 +516,8 @@ } /*! - Returns the object at index <code>anIndex</code>. - @throws CPRangeException if <code>anIndex</code> is out of bounds + Returns the object at index \c anIndex. + @throws CPRangeException if \c anIndex is out of bounds */ - (id)objectAtIndex:(int)anIndex { @@ -528,7 +528,7 @@ } /*! - Returns the objects at <code>indexes</code> in a new CPArray. + Returns the objects at \c indexes in a new CPArray. @param indexes the set of indices @throws CPRangeException if any of the indices is greater than or equal to the length of the array */ @@ -570,7 +570,7 @@ /*! Sends each element in the array a message. @param aSelector the selector of the message to send - @throws CPInvalidArgumentException if <code>aSelector</code> is <code>nil</code> + @throws CPInvalidArgumentException if \c aSelector is \c nil */ - (void)makeObjectsPerformSelector:(SEL)aSelector { @@ -588,7 +588,7 @@ Sends each element in the array a message with an argument. @param aSelector the selector of the message to send @param anObject the first argument of the message - @throws CPInvalidArgumentException if <code>aSelector</code> is <code>nil</code> + @throws CPInvalidArgumentException if \c aSelector is \c nil */ - (void)makeObjectsPerformSelector:(SEL)aSelector withObject:(id)anObject { @@ -605,8 +605,8 @@ // Comparing arrays /*! Returns the first object found in the receiver (starting at index 0) which is present in the - <code>otherArray</code> as determined by using the <code>-containsObject:</code> method. - @return the first object found, or <code>nil</code> if no common object was found. + \c otherArray as determined by using the \c -containsObject: method. + @return the first object found, or \c nil if no common object was found. */ - (id)firstObjectCommonWithArray:(CPArray)anArray { @@ -663,9 +663,9 @@ // Deriving new arrays /*! - Returns a copy of this array plus <code>anObject</code> inside the copy. + Returns a copy of this array plus \c anObject inside the copy. @param anObject the object to be added to the array copy - @throws CPInvalidArgumentException if <code>anObject</code> is <code>nil</code> + @throws CPInvalidArgumentException if \c anObject is \c nil @return a new array that should be n+1 in size compared to the receiver. */ - (CPArray)arrayByAddingObject:(id)anObject @@ -682,7 +682,7 @@ } /*! - Returns a new array which is the concatenation of <code>self</code> and otherArray (in this precise order). + Returns a new array which is the concatenation of \c self and otherArray (in this precise order). @param anArray the array that will be concatenated to the receiver's copy */ - (CPArray)arrayByAddingObjectsFromArray:(CPArray)anArray @@ -706,7 +706,7 @@ */ /*! - Returns a subarray of the receiver containing the objects found in the specified range <code>aRange</code>. + Returns a subarray of the receiver containing the objects found in the specified range \c aRange. @param aRange the range of objects to be copied into the subarray @throws CPRangeException if the specified range exceeds the bounds of the array */ @@ -741,8 +741,8 @@ /*! Returns an array in which the objects are ordered according - to a sort with <code>aFunction</code>. This invokes - <code>-sortUsingFunction:context</code>. + to a sort with \c aFunction. This invokes + \c -sortUsingFunction:context. @param aFunction a JavaScript 'Function' type that compares objects @param aContext context information @return a new sorted array @@ -757,7 +757,7 @@ } /*! - Returns a new array in which the objects are ordered according to a sort with <code>aSelector</code>. + Returns a new array in which the objects are ordered according to a sort with \c aSelector. @param aSelector the selector that will perform object comparisons */ - (CPArray)sortedArrayUsingSelector:(SEL)aSelector @@ -774,7 +774,7 @@ /*! Returns a string formed by concatenating the objects in the receiver, with the specified separator string inserted between each part. - If the element is a Objective-J object, then the <code>description</code> + If the element is a Objective-J object, then the \c -description of that object will be used, otherwise the default JavaScript representation will be used. @param aString the separator that will separate each object string @return the string representation of the array @@ -816,7 +816,7 @@ // Collecting paths /*! Returns a new array subset formed by selecting the elements that have - filename extensions from <code>filterTypes</code>. Only elements + filename extensions from \c filterTypes. Only elements that are of type CPString are candidates for inclusion in the returned array. @param filterTypes an array of CPString objects that contain file extensions (without the '.') @return a new array with matching paths @@ -850,7 +850,7 @@ } /*! - Returns the value for <code>aKey</code> from each element in the array. + Returns the value for \c aKey from each element in the array. @param aKey the key to return the value for @return an array of containing a value for each element in the array */ @@ -883,7 +883,7 @@ // Creating arrays /*! - Creates an array able to store at least <code>aCapacity</code> + Creates an array able to store at least \c aCapacity items. Because CPArray is backed by JavaScript arrays, this method ends up simply returning a regular array. */ @@ -893,7 +893,7 @@ } /*! - Initializes an array able to store at least <code>aCapacity</code> items. Because CPArray + Initializes an array able to store at least \c aCapacity items. Because CPArray is backed by JavaScript arrays, this method ends up simply returning a regular array. */ - (id)initWithCapacity:(unsigned)aCapacity @@ -903,7 +903,7 @@ // Adding and replacing objects /*! - Adds <code>anObject</code> to the end of the array. + Adds \c anObject to the end of the array. @param anObject the object to add to the array */ - (void)addObject:(id)anObject @@ -912,7 +912,7 @@ } /*! - Adds the objects in <code>anArray</code> to the receiver array. + Adds the objects in \c anArray to the receiver array. @param anArray the array of objects to add to the end of the receiver */ - (void)addObjectsFromArray:(CPArray)anArray @@ -923,7 +923,7 @@ /*! Inserts an object into the receiver at the specified location. @param anObject the object to insert into the array - @param anIndex the location to insert <code>anObject</code> at + @param anIndex the location to insert \c anObject at */ - (void)insertObject:(id)anObject atIndex:(int)anIndex { @@ -956,9 +956,9 @@ } /*! - Replaces the element at <code>anIndex</code> with <code>anObject</code>. - The current element at position <code>anIndex</code> will be removed from the array. - @param anIndex the position in the array to place <code>anObject</code> + Replaces the element at \c anIndex with \c anObject. + The current element at position \c anIndex will be removed from the array. + @param anIndex the position in the array to place \c anObject */ - (void)replaceObjectAtIndex:(int)anIndex withObject:(id)anObject { @@ -966,8 +966,8 @@ } /*! - Replace the elements at the indices specified by <code>anIndexSet</code> with - the objects in <code>objects</code>. + Replace the elements at the indices specified by \c anIndexSet with + the objects in \c objects. @param anIndexSet the set of indices to array positions that will be replaced @param objects the array of objects to place in the specified indices */ @@ -984,12 +984,12 @@ } /*! - Replaces some of the receiver's objects with objects from <code>anArray</code>. Specifically, the elements of the - receiver in the range specified by <code>aRange</code>, - with the elements of <code>anArray</code> in the range specified by <code>otherRange</code>. + Replaces some of the receiver's objects with objects from \c anArray. Specifically, the elements of the + receiver in the range specified by \c aRange, + with the elements of \c anArray in the range specified by \c otherRange. @param aRange the range of elements to be replaced in the receiver @param anArray the array to retrieve objects for placement into the receiver - @param otherRange the range of objects in <code>anArray</code> to pull from for placement into the receiver + @param otherRange the range of objects in \c anArray to pull from for placement into the receiver */ - (void)replaceObjectsInRange:(CPRange)aRange withObjectsFromArray:(CPArray)anArray range:(CPRange)otherRange { @@ -1001,8 +1001,8 @@ /*! Replaces some of the receiver's objects with the objects from - <code>anArray</code>. Specifically, the elements of the - receiver in the range specified by <code>aRange</code>. + \c anArray. Specifically, the elements of the + receiver in the range specified by \c aRange. @param aRange the range of elements to be replaced in the receiver @param anArray the array to retrieve objects for placement into the receiver */ @@ -1012,7 +1012,7 @@ } /*! - Sets the contents of the receiver to be identical to the contents of <code>anArray</code>. + Sets the contents of the receiver to be identical to the contents of \c anArray. @param anArray the array of objects used to replace the receiver's objects */ - (void)setArray:(CPArray)anArray @@ -1040,7 +1040,7 @@ } /*! - Removes all entries of <code>anObject</code> from the array. + Removes all entries of \c anObject from the array. @param anObject the object whose entries are to be removed */ - (void)removeObject:(id)anObject @@ -1049,7 +1049,7 @@ } /*! - Removes all entries of <code>anObject</code> from the array, in the range specified by <code>aRange</code>. + Removes all entries of \c anObject from the array, in the range specified by \c aRange. @param anObject the object to remove @param aRange the range to search in the receiver for the object */ @@ -1065,7 +1065,7 @@ } /*! - Removes the object at <code>anIndex</code>. + Removes the object at \c anIndex. @param anIndex the location of the element to be removed */ - (void)removeObjectAtIndex:(int)anIndex @@ -1074,7 +1074,7 @@ } /*! - Removes the objects at the indices specified by <code>CPIndexSet</code>. + Removes the objects at the indices specified by \c CPIndexSet. @param anIndexSet the indices of the elements to be removed from the array */ - (void)removeObjectsAtIndexes:(CPIndexSet)anIndexSet @@ -1089,8 +1089,8 @@ } /*! - Remove the first instance of <code>anObject</code> from the array. - The search for the object is done using <code>==</code>. + Remove the first instance of \c anObject from the array. + The search for the object is done using \c ==. @param anObject the object to remove */ - (void)removeObjectIdenticalTo:(id)anObject @@ -1099,9 +1099,9 @@ } /*! - Remove the first instance of <code>anObject</code> from the array, - within the range specified by <code>aRange</code>. - The search for the object is done using <code>==</code>. + Remove the first instance of \c anObject from the array, + within the range specified by \c aRange. + The search for the object is done using \c ==. @param anObject the object to remove @param aRange the range in the array to search for the object */ @@ -1117,7 +1117,7 @@ } /*! - Remove the objects in <code>anArray</code> from the receiver array. + Remove the objects in \c anArray from the receiver array. @param anArray the array of objects to remove from the receiver */ - (void)removeObjectsInArray:(CPArray)anArray @@ -1170,7 +1170,7 @@ /*! Sorts the receiver array using a JavaScript function as a comparator, and a specified context. @param aFunction a JavaScript function that will be called to compare objects - @param aContext an object that will be passed to <code>aFunction</code> with comparison + @param aContext an object that will be passed to \c aFunction with comparison */ - (void)sortUsingFunction:(Function)aFunction context:(id)aContext { Foundation/CPArray.j @@ -51,7 +51,7 @@ /*! Creates a new attributed string from a character string. @param aString is the string to initialise from. - @return a new CPAttributedString containing the string <code>aString</code>. + @return a new CPAttributedString containing the string \c aString. */ - (id)initWithString:(CPString)aString { @@ -61,7 +61,7 @@ /*! Creates a new attributed string from an existing attributed string. @param aString is the attributed string to initialise from. - @return a new CPAttributedString containing the string <code>aString</code>. + @return a new CPAttributedString containing the string \c aString. */ - (id)initWithAttributedString:(CPAttributedString)aString { @@ -77,8 +77,8 @@ dictionary of attributes. @param aString is the attributed string to initialise from. @param attributes is a dictionary of string attributes. - @return a new CPAttributedString containing the string <code>aString</code> - with associated attributes, <code>attributes</code>. + @return a new CPAttributedString containing the string \c aString + with associated attributes, \c attributes. */ - (id)initWithString:(CPString)aString attributes:(CPDictionary)attributes { @@ -152,16 +152,16 @@ same, can be returned if desired. @note there is no guarantee that the range returned is in fact the complete range of the particular attributes. To ensure this use - <code>attributesAtIndex:longestEffectiveRange:inRange:</code> instead. Note + \c attributesAtIndex:longestEffectiveRange:inRange: instead. Note however that it may take significantly longer to execute. @param anIndex is an unsigned integer index. It must lie within the bounds of the string. @param aRange is a reference to a CPRange object that is set (upon return) to the range over which the attributes are the - same as those at index, <code>anIndex</code>. If not required pass - <code>nil</code>. + same as those at index, \c anIndex. If not required pass + \c nil. @return a CPDictionary containing the attributes associated with the - character at index <code>anIndex</code>. Returns <code>nil</code> if index + character at index \c anIndex. Returns \c nil if index is out of bounds. */ - (CPDictionary)attributesAtIndex:(unsigned)anIndex effectiveRange:(CPRangePointer)aRange @@ -187,10 +187,10 @@ and, by reference, the range over which the attributes apply. This is the maximum range both forwards and backwards in the string over which the attributes apply, bounded in both directions by the range limit parameter, - <code>rangeLimit</code>. + \c rangeLimit. @note this method performs a search to find this range which may be - computationally intensive. Use the <code>rangeLimit</code> to limit the - search space or use <code>attributesAtIndex:effectiveRange:</code> but + computationally intensive. Use the \c rangeLimit to limit the + search space or use \c -attributesAtIndex:effectiveRange: but note that it is not guaranteed to return the full range of the current character's attributes. @param anIndex is the unsigned integer index. It must lie within the bounds @@ -200,7 +200,7 @@ @param rangeLimit a range limiting the search for the attributes' applicable range. @return a CPDictionary containing the attributes associated with the - character at index <code>anIndex</code>. Returns <code>nil</code> if index + character at index \c anIndex. Returns \c nil if index is out of bounds. */ - (CPDictionary)attributesAtIndex:(unsigned)anIndex longestEffectiveRange:(CPRangePointer)aRange inRange:(CPRange)rangeLimit @@ -268,15 +268,15 @@ required, the range over which the attribute applies. @note there is no guarantee that the range returned is in fact the complete range of a particular attribute. To ensure this use - <code>attribute:atIndex:longestEffectiveRange:inRange:</code> instead but + \c -attribute:atIndex:longestEffectiveRange:inRange: instead but note that it may take significantly longer to execute. @param attribute the name of the desired attribute. @param anIndex is an unsigned integer character index from which to retrieve the attribute. It must lie within the bounds of the string. @param aRange is a reference to a CPRange object, that is set upon return to the range over which the named attribute applies. If not required pass - <code>nil</code>. - @return the named attribute or <code>nil</code> is the attribute does not + \c nil. + @return the named attribute or \c nil is the attribute does not exist. */ - (id)attribute:(CPString)attribute atIndex:(unsigned)index effectiveRange:(CPRangePointer)aRange @@ -300,10 +300,10 @@ range over which the attribute applies. This is the maximum range both forwards and backwards in the string over which the attribute applies, bounded in both directions by the range limit parameter, - <code>rangeLimit</code>. + \c rangeLimit. @note this method performs a search to find this range which may be - computationally intensive. Use the <code>rangeLimit</code> to limit the - search space or use <code>attribute:atIndex:effectiveRange:</code> but + computationally intensive. Use the \c rangeLimit to limit the + search space or use \c -attribute:atIndex:effectiveRange: but note that it is not guaranteed to return the full range of the current character's named attribute. @param attribute the name of the desired attribute. @@ -313,7 +313,7 @@ to the range over which the named attribute applies. @param rangeLimit a range limiting the search for the attribute's applicable range. - @return the named attribute or <code>nil</code> is the attribute does not + @return the named attribute or \c nil is the attribute does not exist. */ - (id)attribute:(CPString)attribute atIndex:(unsigned)anIndex longestEffectiveRange:(CPRangePointer)aRange inRange:(CPRange)rangeLimit @@ -380,7 +380,7 @@ //Comparing Attributed Strings /*! Compares the receiver's characters and attributes to the specified - attributed string, <code>aString</code>, and tests for equality. + attributed string, \c aString, and tests for equality. @param aString the CPAttributedString to compare. @return a boolean indicating equality. */ @@ -432,7 +432,7 @@ //Extracting a Substring /*! Extracts a substring from the receiver, both characters and attributes, - within the range given by <code>aRange</code>. + within the range given by \c aRange. @param aRange the range of the substring to extract. @return a CPAttributedString containing the desired substring. @exception CPRangeException if the range lies outside the receiver's bounds. @@ -487,13 +487,13 @@ //Changing Characters /*! Replaces the characters in the receiver with those of the specified string - over the range, <code>aRange</code>. If the range has a length of 0 then + over the range, \c aRange. If the range has a length of 0 then the specified string is inserted at the range location. The new characters inherit the attributes of the first character in the range that they replace or in the case if a 0 range length, the first character before of after the insert (after if the insert is at location 0). @note the replacement string need not be the same length as the range - being replaced. The full <code>aString</code> is inserted and thus the + being replaced. The full \c aString is inserted and thus the receiver's length changes to match this @param aRange the range of characters to replace. @param aString the string to replace the specified characters in the @@ -549,11 +549,11 @@ @note This process removes the attributes already associated with the character range. If you wish to retain the current attributes use - <code>addAttributes:range:</code>. + \c -addAttributes:range:. @param aDictionary a CPDictionary of attributes (names and values) to set to. @param aRange a CPRange indicating the range of characters to set their - associated attributes to <code>aDictionary</code>. + associated attributes to \c aDictionary. */ - (void)setAttributes:(CPDictionary)aDictionary range:(CPRange)aRange { @@ -580,7 +580,7 @@ @note Attributes currently associated with the characters in the range are untouched. To remove all previous attributes when adding use - <code>setAttributes:range:</code>. + \c -setAttributes:range:. @param aDictionary a CPDictionary of attributes (names and values) to add. @param aRange a CPRange indicating the range of characters to add the attributes to. @@ -619,7 +619,7 @@ @note Attributes currently associated with the characters in the range are untouched. To remove all previous attributes when adding use - <code>setAttributes:range:</code>. + \c -setAttributes:range:. @param anAttribute a CPString of the attribute name. @param aValue a value to assign to the attribute. Can be of any type. @param aRange a CPRange indicating the range of characters to add the @@ -654,7 +654,7 @@ /*! Inserts an attributed string (characters and attributes) at index, - <code>anIndex</code>, into the receiver. The portion of the + \c anIndex, into the receiver. The portion of the receiver's attributed string from the specified index to the end is shifted until after the inserted string. @param aString a CPAttributedString to insert. @@ -699,8 +699,8 @@ } /*! - Replaces characters and attributes in the range <code>aRange</code> with - those of the given attributed string, <code>aString</code>. + Replaces characters and attributes in the range \c aRange with + those of the given attributed string, \c aString. @param aRange a CPRange object specifying the range of characters and attributes in the object to replace. @param aString a CPAttributedString containing the data to be used for @@ -717,7 +717,7 @@ } /*! - Sets the objects characters and attributes to those of <code>aString</code>. + Sets the objects characters and attributes to those of \c aString. @param aString is a CPAttributedString from which the contents will be copied. */ Foundation/CPAttributedString.j @@ -39,7 +39,7 @@ /*! Returns a flag indicating whether the receiver supports keyed coding. The default implementation returns - <code>NO</code>. Subclasses supporting keyed coding must override this to return <code>YES</code>. + \c NO. Subclasses supporting keyed coding must override this to return \c YES. */ -(BOOL)allowsKeyedCoding { @@ -148,7 +148,7 @@ /*! Called after an object is unarchived in case a different object should be used in place of it. - The defaut method returns <code>self</code>. Interested subclasses should override this. + The defaut method returns \c self. Interested subclasses should override this. @param aDecoder @return the original object or it's substitute. */ Foundation/CPCoder.j @@ -70,7 +70,7 @@ If you are familiar with dictionaries in Cocoa, you'll notice that there is no CPMutableDictionary class. The regular CPDictionary - has <code>setObject:</code> and <code>removeObjectForKey:</code> methods. + has \c -setObject:forKey: and \c -removeObjectForKey: methods. In Cappuccino there is no distinction between immutable and mutable classes. They are all mutable. */ @@ -95,7 +95,7 @@ } /*! - Returns a new dictionary, initialized with the contents of <code>aDictionary</code>. + Returns a new dictionary, initialized with the contents of \c aDictionary. @param aDictionary the dictionary to copy key-value pairs from @return the new CPDictionary */ @@ -402,7 +402,7 @@ } */ /*! - Returns the object for the entry with key <code>aKey</code>. + Returns the object for the entry with key \c aKey. @param aKey the key for the object's entry @return the object for the entry */ Foundation/CPDictionary.j @@ -147,7 +147,7 @@ /*! Compares the receiver with the provided index set. @param anIndexSet the index set to compare to - @return <code>YES</code> if the receiver and the index set are functionally equivalent + @return \c YES if the receiver and the index set are functionally equivalent */ - (BOOL)isEqualToIndexSet:(CPIndexSet)anIndexSet { @@ -172,9 +172,9 @@ } /*! - Returns <code>YES</code> if the index set contains the specified index. + Returns \c YES if the index set contains the specified index. @param anIndex the index to check for in the set - @return <code>YES</code> if <code>anIndex</code> is in the receiver index set + @return \c YES if \c anIndex is in the receiver index set */ - (BOOL)containsIndex:(unsigned)anIndex { @@ -182,7 +182,7 @@ } /*! - Returns <code>YES</code> if the index set contains all the numbers in the specified range. + Returns \c YES if the index set contains all the numbers in the specified range. @param aRange the range of numbers to check for in the index set */ - (BOOL)containsIndexesInRange:(CPRange)aRange @@ -213,7 +213,7 @@ } /*! - Returns <code>YES</code> if the receving index set contains all the indices in the argument. + Returns \c YES if the receving index set contains all the indices in the argument. @param anIndexSet the set of indices to check for in the receiving index set */ - (BOOL)containsIndexes:(CPIndexSet)anIndexSet @@ -238,9 +238,9 @@ } /*! - Checks if the receiver contains at least one number in <code>aRange</code>. + Checks if the receiver contains at least one number in \c aRange. @param aRange the range of numbers to check. - @return <code>YES</code> if the receiving index set contains at least one number in the provided range + @return \c YES if the receiving index set contains at least one number in the provided range */ - (BOOL)intersectsIndexesInRange:(CPRange)aRange { @@ -287,7 +287,7 @@ } /*! - Returns the first index value in the receiver which is greater than <code>anIndex</code>. + Returns the first index value in the receiver which is greater than \c anIndex. @return the closest index or CPNotFound if no match was found */ - (unsigned)indexGreaterThanIndex:(unsigned)anIndex @@ -312,7 +312,7 @@ } /*! - Returns the first index value in the receiver which is less than <code>anIndex</code>. + Returns the first index value in the receiver which is less than \c anIndex. @return the closest index or CPNotFound if no match was found */ - (unsigned)indexLessThanIndex:(unsigned)anIndex @@ -339,7 +339,7 @@ } /*! - Returns the first index value in the receiver which is greater than or equal to <code>anIndex</code>. + Returns the first index value in the receiver which is greater than or equal to \c anIndex. @return the matching index or CPNotFound if no match was found */ - (unsigned int)indexGreaterThanOrEqualToIndex:(unsigned)anIndex @@ -348,7 +348,7 @@ } /*! - Returns the first index value in the receiver which is less than or equal to <code>anIndex</code>. + Returns the first index value in the receiver which is less than or equal to \c anIndex. @return the matching index or CPNotFound if no match was found */ - (unsigned int)indexLessThanOrEqualToIndex:(unsigned)anIndex @@ -359,7 +359,7 @@ /*! Fills up the specified array with numbers from the index set within the specified range. The method stops filling up the array until the - <code>aMaxCount</code> number have been added or the range maximum is reached. + \c aMaxCount number have been added or the range maximum is reached. @param anArray the array to fill up @param aMaxCount the maximum number of numbers to adds @param aRangePointer the range of indices to add Foundation/CPIndexSet.j @@ -103,7 +103,7 @@ } /*! - Sets a method argument for the invocation. Arguments 0 and 1 are <code>self</code> and <code>_cmd</code>. + Sets a method argument for the invocation. Arguments 0 and 1 are \c self and \c _cmd. @param anArgument the argument to add @param anIndex the index of the argument in the method */ @@ -114,7 +114,7 @@ /*! Returns the argument at the specified index. Arguments 0 and 1 are - <code>self</code> and <code>_cmd</code> respectively. Thus, method arguments start at 2. + \c self and \c _cmd respectively. Thus, method arguments start at 2. @param anIndex the index of the argument to return @throws CPInvalidArgumentException if anIndex is greater than or equal to the invocation's number of arguments. */ Foundation/CPInvocation.j @@ -68,7 +68,7 @@ var _CPKeyedArchiverStringClass = Nil, Implements keyed archiving of object graphs. Archiving means to write data out in a format that be read in again later, or possibly stored in a file. To read the data back in, use a - <code>CPKeyedUnarchiver</code>. + \c CPKeyedUnarchiver. @par Delegate Methods @@ -87,7 +87,7 @@ var _CPKeyedArchiverStringClass = Nil, @delegate -(id)archiver:(CPKeyedArchiver)archiver willEncodeObject:(id)object; Called when an object is about to be encoded. Allows the delegate to replace - the object that gets encoded with a substitute or <code>nil</code>. + the object that gets encoded with a substitute or \c nil. @param archiver the archiver encoding the object @param object the candidate object for encoding @return the object to encode @@ -158,7 +158,7 @@ var _CPKeyedArchiverStringClass = Nil, // Initializing an NSKeyedArchiver object /*! - Initializes the keyed archiver with the specified <code>CPMutableData</code> for writing. + Initializes the keyed archiver with the specified \c CPMutableData for writing. @param data the object to archive to @return the initialized keyed archiver */ @@ -246,9 +246,9 @@ var _CPKeyedArchiverStringClass = Nil, } /*! - Encodes a <code>BOOL</code> value - @param aBool the <code>BOOL</code> value - @param aKey the key to associate with the <code>BOOL</code> + Encodes a \c BOOL value + @param aBool the \c BOOL value + @param aKey the key to associate with the \c BOOL */ - (void)encodeBool:(BOOL)aBOOL forKey:(CPString)aKey { @@ -256,9 +256,9 @@ var _CPKeyedArchiverStringClass = Nil, } /*! - Encodes a <code>double</code> value - @param aDouble the <code>double</code> value - @param aKey the key to associate with the <code>double</code> + Encodes a \c double value + @param aDouble the \c double value + @param aKey the key to associate with the \c double */ - (void)encodeDouble:(double)aDouble forKey:(CPString)aKey { @@ -266,9 +266,9 @@ var _CPKeyedArchiverStringClass = Nil, } /*! - Encodes a <code>float</code> value - @param aFloat the <code>float</code> value - @param aKey the key to associate with the <code>float</code> + Encodes a \c float value + @param aFloat the \c float value + @param aKey the key to associate with the \c float */ - (void)encodeFloat:(float)aFloat forKey:(CPString)aKey { @@ -276,9 +276,9 @@ var _CPKeyedArchiverStringClass = Nil, } /*! - Encodes a <code>int</code> value - @param anInt the <code>int</code> value - @param aKey the key to associate with the <code>int</code> + Encodes a \c int value + @param anInt the \c int value + @param aKey the key to associate with the \c int */ - (void)encodeInt:(float)anInt forKey:(CPString)aKey { @@ -409,8 +409,8 @@ var _CPKeyedArchiverStringClass = Nil, // Managing classes and class names /*! Allows substitution of class types for encoding. Specifically classes - of type <code>aClass</code> encountered by all keyed archivers will - instead be archived as a class of type <code>aClassName</code>. + of type \c aClass encountered by all keyed archivers will + instead be archived as a class of type \c aClassName. @param aClassName the substitute class name @param aClass the class to substitute */ @@ -424,9 +424,9 @@ var _CPKeyedArchiverStringClass = Nil, /*! Returns the name of the substitute class used for encoding - <code>aClass</code> by all keyed archivers. + \c aClass by all keyed archivers. @param aClass the class to substitute - @return the name of the substitute class, or <code>nil</code> if there + @return the name of the substitute class, or \c nil if there is no substitute class */ + (CPString)classNameForClass:(Class)aClass @@ -441,8 +441,8 @@ var _CPKeyedArchiverStringClass = Nil, /*! Allows substitution of class types for encoding. Specifically classes - of type <code>aClass</code> encountered by this keyed archiver will - instead be archived as a class of type <code>aClassName</code>. + of type \c aClass encountered by this keyed archiver will + instead be archived as a class of type \c aClassName. @param aClassName the substitute class name @param aClass the class to substitute */ @@ -455,9 +455,9 @@ var _CPKeyedArchiverStringClass = Nil, } /*! - Returns the name of the substitute class used for encoding <code>aClass</code> by this keyed archiver. + Returns the name of the substitute class used for encoding \c aClass by this keyed archiver. @param aClass the class to substitute - @return the name of the substitute class, or <code>nil</code> if there is no substitute class + @return the name of the substitute class, or \c nil if there is no substitute class */ - (CPString)classNameForClass:(Class)aClass { Foundation/CPKeyedArchiver.j @@ -75,7 +75,7 @@ var _CPKeyedUnarchiverArrayClass = Ni @param an array of class names describing the encoded object's class hierarchy. The first index is the encoded class name, and each superclass is after that. - @return the Class to use instead or <code>nil</code> + @return the Class to use instead or \c nil to abort the unarchiving operation @delegate -(id)unarchiver:(CPKeyedUnarchiver)unarchiver didDecodeObject:(id)object; @@ -83,10 +83,10 @@ var _CPKeyedUnarchiverArrayClass = Ni @param unarchiver the unarchiver doing the decoding @param object the decoded objec @return a substitute to use for the decoded object. This can be the same object argument provide, - another object or <code>nil</code>. + another object or \c nil. @delegate -(void)unarchiver:(CPKeyedUnarchiver)unarchiver willReplaceObject:(id)object withObject:(id)newObject; - Called when a decoded object has been substituted with another. (for example, from <code>unarchiver:didDecodeObject:</code>. + Called when a decoded object has been substituted with another. (for example, from \c -unarchiver:didDecodeObject:. @param unarchiver the unarchiver that decoded the object @param object the original decoded object @param newObject the replacement object @@ -184,7 +184,7 @@ var _CPKeyedUnarchiverArrayClass = Ni } /* - Returns <code>YES</code> if an object exists for <code>aKey</code>. + Returns \c YES if an object exists for \c aKey. @param aKey the object's associated key */ - (BOOL)containsValueForKey:(CPString)aKey @@ -213,9 +213,9 @@ var _CPKeyedUnarchiverArrayClass = Ni } /* - Decodes a <code>BOOL</code> from the archive - @param aKey the <code>BOOL</code>'s associated key - @return the decoded <code>BOOL</code> + Decodes a \c BOOL from the archive + @param aKey the \c BOOL's associated key + @return the decoded \c BOOL */ - (BOOL)decodeBoolForKey:(CPString)aKey { @@ -223,9 +223,9 @@ var _CPKeyedUnarchiverArrayClass = Ni } /* - Decodes a <code>float</code> from the archive - @param aKey the <code>float</code>'s associated key - @return the decoded <code>float</code> + Decodes a \c float from the archive + @param aKey the \c float's associated key + @return the decoded \c float */ - (float)decodeFloatForKey:(CPString)aKey { @@ -233,9 +233,9 @@ var _CPKeyedUnarchiverArrayClass = Ni } /* - Decodes a <code>double</code> from the archive. - @param aKey the <code>double</code>'s associated key - @return the decoded <code>double</code> + Decodes a \c double from the archive. + @param aKey the \c double's associated key + @return the decoded \c double */ - (double)decodeDoubleForKey:(CPString)aKey { @@ -243,9 +243,9 @@ var _CPKeyedUnarchiverArrayClass = Ni } /* - Decodes an <code>int</code> from the archive. - @param aKey the <code>int</code>'s associated key - @return the decoded <code>int</code> + Decodes an \c int from the archive. + @param aKey the \c int's associated key + @return the decoded \c int */ - (int)decodeIntForKey:(CPString)aKey { Foundation/CPKeyedUnarchiver.j @@ -72,7 +72,7 @@ var CPNotificationDefaultCenter = nil; /*! Adds an object as an observer. The observer will receive notifications with the specified name - and/or containing the specified object (depending on if they are <code>nil</code>. + and/or containing the specified object (depending on if they are \c nil. @param anObserver the observing object @param aSelector the message sent to the observer when a notification occurrs @param aNotificationName the name of the notification the observer wants to watch Foundation/CPNotificationCenter.j @@ -28,10 +28,10 @@ var CPNullSharedNull = nil; /*! @class CPNull @ingroup foundation - @brief An object representation of <code>nil</code>. + @brief An object representation of \c nil. - This class is used as an object representation of <code>nil</code>. This is handy when a collection - only accepts objects as values, but you would like a <code>nil</code> representation in there. + This class is used as an object representation of \c nil. This is handy when a collection + only accepts objects as values, but you would like a \c nil representation in there. */ @implementation CPNull : CPObject { @@ -46,7 +46,7 @@ var CPNullSharedNull = nil; }*/ /*! Returns the singleton instance of the CPNull - object. While CPNull and <code>nil</code> should + object. While CPNull and \c nil should be <i>interpreted</i> as the same, they are not equal ('=='). */ + (CPNull)null Foundation/CPNull.j @@ -33,7 +33,7 @@ var __placeholder = new Number(), @brief A bridged object to native Javascript numbers. This class primarily exists for source compatability. The JavaScript - <code>Number</code> type can be changed on the fly based on context, + \c Number type can be changed on the fly based on context, so there is no need to call any of these methods. In other words, native JavaScript numbers are bridged to CPNumber, Foundation/CPNumber.j @@ -55,9 +55,9 @@ To get description value you can use %@ specifier everywhere where format specifiers are allowed: <pre>var inst = [[SomeClass alloc] initWithSomeValue:10]; -CPLog(@"Got some class: %@", inst);</pre> +CPLog(@"Got some class: %@", inst); would output: - <pre>Got some class: <SomeClass 10></pre> + \c Got \c some \c class: \c <SomeClass \c 10> @todo document KVC usage. */ @@ -76,7 +76,7 @@ CPLog(@"Got some class: %@", inst);</pre> } /*! - Allocates a new instance of the receiver, and sends it an <code>init</code> + Allocates a new instance of the receiver, and sends it an \c -init @return the new object */ + (id)new @@ -158,7 +158,7 @@ CPLog(@"Got some class: %@", inst);</pre> } /*! - Returns <code>YES</code> if the receiving class is a subclass of <code>aClass</code>. + Returns \c YES if the receiving class is a subclass of \c aClass. @param aClass the class to test inheritance from */ + (BOOL)isSubclassOfClass:(Class)aClass @@ -173,7 +173,7 @@ CPLog(@"Got some class: %@", inst);</pre> } /*! - Returns <code>YES</code> if the receiver is a <code>aClass</code> type, or a subtype of it. + Returns \c YES if the receiver is a \c aClass type, or a subtype of it. @param aClass the class to test as the receiver's class or super class. */ - (BOOL)isKindOfClass:(Class)aClass @@ -187,7 +187,7 @@ CPLog(@"Got some class: %@", inst);</pre> } /*! - Returns <code>YES</code> if the receiver is of the <code>aClass</code> class type. + Returns \c YES if the receiver is of the \c aClass class type. @param aClass the class to test the receiper */ - (BOOL)isMemberOfClass:(Class)aClass @@ -202,7 +202,7 @@ CPLog(@"Got some class: %@", inst);</pre> /*! Determines whether the receiver's root object is a proxy. - @return <code>YES</code> if the root object is a proxy + @return \c YES if the root object is a proxy */ - (BOOL)isProxy { @@ -213,7 +213,7 @@ CPLog(@"Got some class: %@", inst);</pre> /*! Test whether instances of this class respond to the provided selector. @param aSelector the selector for which to test the class - @return <code>YES</code> if instances of the class respond to the selector + @return \c YES if instances of the class respond to the selector */ + (BOOL)instancesRespondToSelector:(SEL)aSelector { @@ -223,7 +223,7 @@ CPLog(@"Got some class: %@", inst);</pre> /*! Tests whether the receiver responds to the provided selector. @param aSelector the selector for which to test the receiver - @return <code>YES</code> if the receiver responds to the selector + @return \c YES if the receiver responds to the selector */ - (BOOL)respondsToSelector:(SEL)aSelector { @@ -310,7 +310,7 @@ CPLog(@"Got some class: %@", inst);</pre> /*! Subclasses can override this method to forward message to other objects. Overwriting this method in conjunction with - <code>methodSignatureForSelector:</code> allows the receiver to + \c -methodSignatureForSelector: allows the receiver to forward messages for which it does not respond, to another object that does. */ - (void)forwardInvocation:(CPInvocation)anInvocation @@ -376,7 +376,7 @@ CPLog(@"Got some class: %@", inst);</pre> /*! Can be overridden by subclasses to substitute a different class to represent the receiver for keyed archiving. - @return the class to use. A <code>nil</code> means to ignore the method result. + @return the class to use. A \c nil means to ignore the method result. */ - (Class)classForKeyedArchiver { @@ -477,8 +477,8 @@ CPLog(@"Got some class: %@", inst);</pre> } /*! - Determines if <code>anObject</code> is functionally equivalent to the receiver. - @return <code>YES</code> if <code>anObject</code> is functionally equivalent to the receiver. + Determines if \c anObject is functionally equivalent to the receiver. + @return \c YES if \c anObject is functionally equivalent to the receiver. */ - (BOOL)isEqual:(id)anObject { Foundation/CPObject.j @@ -60,7 +60,7 @@ function CPMakeRangeCopy(aRange) } /*! - Sets a range's <code>length</code> to 0. + Sets a range's \c length to 0. @param aRange the range to empty @group CPRange @return CPRange the empty range (same as the argument) @@ -71,7 +71,7 @@ function CPEmptyRange(aRange) } /*! - Finds the range maximum. (<code>location + length</code>) + Finds the range maximum. (\c location + length) @param aRange the range to calculate a maximum from @group CPRange @return int the range maximum @@ -85,7 +85,7 @@ function CPMaxRange(aRange) Determines if two CPRanges are equal. @param lhsRange the first CPRange @param rhsRange the second CPRange - @return BOOL <code>YES</code> if the two CPRanges are equal. + @return BOOL \c YES if the two CPRanges are equal. */ function CPEqualRanges(lhsRange, rhsRange) { @@ -97,7 +97,7 @@ function CPEqualRanges(lhsRange, rhsRange) @param aLocation the number to check @param aRange the CPRange to check within @group CPRange - @return BOOL <code>YES</code> if <code>aLocation/code> is within the range + @return BOOL \c YES if \c aLocation is within the range */ function CPLocationInRange(aLocation, aRange) { @@ -105,8 +105,8 @@ function CPLocationInRange(aLocation, aRange) } /*! - Creates a new range with the minimum <code>location</code> and a <code>length</code> - that extends to the maximum <code>length</code>. + Creates a new range with the minimum \c location and a \c length + that extends to the maximum \c length. @param lhsRange the first CPRange @param rhsRange the second CPRange @group CPRange Foundation/CPRange.j @@ -94,7 +94,7 @@ CPOrderedDescending = 1; // Getting information about a sort descriptor /*! - Returns <code>YES</code> if the sort descriptor's order is ascending. + Returns \c YES if the sort descriptor's order is ascending. */ - (BOOL)ascending { Foundation/CPSortDescriptor.j @@ -71,7 +71,7 @@ var CPStringRegexSpecialCharacters = [ @brief An immutable string (collection of characters). CPString is an object that allows management of strings. Because CPString is - based on the JavaScript <code>String</code> object, CPStrings are immutable, although the + based on the JavaScript \c String object, CPStrings are immutable, although the class does have methods that create new CPStrings generated from modifications to the receiving instance. @@ -108,8 +108,8 @@ var CPStringRegexSpecialCharacters = [ /*! Returns a copy of the specified string. - @param aString a non-<code>nil</code> string to copy - @throws CPInvalidArgumentException if <code>aString</code> is <code>nil</code> + @param aString a non-\c nil string to copy + @throws CPInvalidArgumentException if \c aString is \c nil @return the new CPString */ + (id)stringWithString:(CPString)aString @@ -249,11 +249,11 @@ var CPStringRegexSpecialCharacters = [ /*! Tokenizes the receiver string using the specified delimiter. For example, if the receiver is: - <pre>"arash.francisco.ross.tom"</pre> + \c "arash.francisco.ross.tom" and the delimiter is: - <pre>"."</pre> + \c "." the returned array would contain: - <pre>["arash", "francisco", "ross", "tom"]</pre> + <pre> ["arash", "francisco", "ross", "tom"] </pre> @param the delimiter @return the array of tokens */ @@ -273,7 +273,7 @@ var CPStringRegexSpecialCharacters = [ } /*! - Returns a substring starting from the specified range <code>location</code> to the range <code>length</code>. + Returns a substring starting from the specified range \c location to the range \c length. @param the range of the substring @return the substring */ @@ -296,7 +296,7 @@ var CPStringRegexSpecialCharacters = [ /*! Finds the range of characters in the receiver where the specified string exists. If the string - does not exist in the receiver, the range <code>length</code> will be 0. + does not exist in the receiver, the range \c length will be 0. @param aString the string to search for in the receiver @return the range of charactrs in the receiver */ @@ -320,7 +320,7 @@ var CPStringRegexSpecialCharacters = [ @param aString the string to search for @param aMask the options to use in the search @return the range of characters in the receiver. If the string was not found, - the <code>length</code> of the range will be 0. + the \c length of the range will be 0. */ - (CPRange)rangeOfString:(CPString)aString options:(int)aMask { @@ -343,7 +343,7 @@ var CPStringRegexSpecialCharacters = [ @param aMask the options to use in the search @param aRange the range of the receiver in which to search for @return the range of characters in the receiver. If the string was not found, - the <code>length</code> of the range will be 0. + the \c length of the range will be 0. */ - (CPRange)rangeOfString:(CPString)aString options:(int)aMask range:(CPrange)aRange { @@ -377,7 +377,7 @@ var CPStringRegexSpecialCharacters = [ Returns a new string in which all occurrences of a target string in the reciever are replaced by another given string. @param target The string to replace. - @param replacement the string with which to replace the <pre>target<pre> + @param replacement the string with which to replace the \c target */ - (CPString)stringByReplacingOccurrencesOfString:(CPString)target withString:(CPString)replacement @@ -389,9 +389,9 @@ var CPStringRegexSpecialCharacters = [ Returns a new string in which all occurrences of a target string in a specified range of the receiver are replaced by another given string. @param target The string to replace - @param replacement the string with which to replace the <pre>target<pre> - @param options A mask of options to use when comparing <pre>target<pre> with the receiver. Pass 0 to specify no options - @param searchRange The range in the receiver in which to search for <pre>target<pre>. + @param replacement the string with which to replace the \c target. + @param options A mask of options to use when comparing \c target with the receiver. Pass 0 to specify no options + @param searchRange The range in the receiver in which to search for \c target. */ - (CPString)stringByReplacingOccurrencesOfString:(CPString)target withString:(CPString)replacement options:(int)options range:(CPRange)searchRange @@ -414,7 +414,7 @@ var CPStringRegexSpecialCharacters = [ Returns a new string in which the characters in a specified range of the receiver are replaced by a given string. @param range A range of characters in the receiver. - @param replacement The string with which to replace the characters in <pre>range</pre>. + @param replacement The string with which to replace the characters in \c range. */ - (CPString)stringByReplacingCharactersInRange:(CPRange)range withString:(CPString)replacement @@ -494,9 +494,9 @@ var CPStringRegexSpecialCharacters = [ } /*! - Returns <code>YES</code> if the receiver starts - with the specified string. If <code>aString</code> - is empty, the method will return <code>NO</code>. + Returns \c YES if the receiver starts + with the specified string. If \c aString + is empty, the method will return \c NO. */ - (BOOL)hasPrefix:(CPString)aString { @@ -504,9 +504,9 @@ var CPStringRegexSpecialCharacters = [ } /*! - Returns <code>NO</code> if the receiver ends - with the specified string. If <code>aString</code> - is empty, the method will return <code>NO</code>. + Returns \c NO if the receiver ends + with the specified string. If \c aString + is empty, the method will return \c NO. */ - (BOOL)hasSuffix:(CPString)aString { @@ -514,7 +514,7 @@ var CPStringRegexSpecialCharacters = [ } /*! - Returns <code>YES</code> if the specified string contains the same characters as the receiver. + Returns \c YES if the specified string contains the same characters as the receiver. */ - (BOOL)isEqualToString:(CPString)aString { @@ -577,8 +577,8 @@ var CPStringRegexSpecialCharacters = [ return parseFloat(self, 10); } /*! - Returns <code>YES</code> on encountering one of "Y", "y", "T", "t", or - a digit 1-9. Returns <code>NO</code> otherwise. This method skips the initial + Returns \c YES on encountering one of "Y", "y", "T", "t", or + a digit 1-9. Returns \c NO otherwise. This method skips the initial whitespace characters, +,- followed by Zeroes. */ Foundation/CPString.j @@ -98,7 +98,7 @@ var CPURLConnectionDelegate = nil; @param aRequest contains the URL to request the data from @param aURLResponse not used @param anError not used - @return the data at the URL or <code>nil</code> if there was an error + @return the data at the URL or \c nil if there was an error */ + (CPData)sendSynchronousRequest:(CPURLRequest)aRequest returningResponse:({CPURLResponse})aURLResponse error:({CPError})anError { @@ -130,7 +130,7 @@ var CPURLConnectionDelegate = nil; Creates a url connection with a delegate to monitor the request progress. @param aRequest contains the URL to obtain data from @param aDelegate will be sent messages related to the request progress - @return a connection that can be <code>start<code>ed to initiate the request + @return a connection that can be \c started to initiate the request */ + (CPURLConnection)connectionWithRequest:(CPURLRequest)aRequest delegate:(id)aDelegate { @@ -141,7 +141,7 @@ var CPURLConnectionDelegate = nil; Default class initializer. Use one of the class methods instead. @param aRequest contains the URL to contact @param aDelegate will receive progress messages - @param shouldStartImmediately whether the <code>start</code> method should be called from here + @param shouldStartImmediately whether the \c -start method should be called from here @return the initialized url connection */ - (id)initWithRequest:(CPURLRequest)aRequest delegate:(id)aDelegate startImmediately:(BOOL)shouldStartImmediately Foundation/CPURLConnection.j @@ -163,8 +163,8 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey", execution of undo or redo actions, and tuning behavior parameters such as the size of the undo stack. Each application entity with its own editing history (e.g., a document) should have its own undo manager instance. - Obtain an instance through a simple <code>[[CPUndoManager alloc] init] - </code> message. + Obtain an instance through a simple \c [[CPUndoManager \c alloc] \c init] + message. */ @implementation CPUndoManager : CPObject { @@ -208,7 +208,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey", // Registering Undo Operations /*! - Registers an undo operation. You invoke this method with the target of the undo action providing the selector which can perform the undo with the provided object. The object is often a dictionary of the identifying the attribute and their values before the change. The invocation will be added to the current grouping. If the registrations have been disabled through <code>-disableUndoRegistration</code>, this method does nothing. + Registers an undo operation. You invoke this method with the target of the undo action providing the selector which can perform the undo with the provided object. The object is often a dictionary of the identifying the attribute and their values before the change. The invocation will be added to the current grouping. If the registrations have been disabled through \c -disableUndoRegistration, this method does nothing. @param aTarget the target for the undo invocation @param aSelector the selector for the action message @param anObject the argument for the action message @@ -287,7 +287,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey", // Checking Undo Ability /*! - Returns <code>YES</code> if the user can perform a redo operation. + Returns \c YES if the user can perform a redo operation. */ - (BOOL)canRedo { @@ -295,7 +295,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey", } /*! - Returns <code>YES</code> if the user can perform an undo operation. + Returns \c YES if the user can perform an undo operation. */ - (BOOL)canUndo { @@ -447,7 +447,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey", } /*! - Returns <code>YES</code> if the manager groups undo operations at every iteration of the run loop. + Returns \c YES if the manager groups undo operations at every iteration of the run loop. */ - (BOOL)groupsByEvent { @@ -456,7 +456,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey", /*! Sets whether the manager should group undo operations at every iteration of the run loop. - @param aFlag <code>YES</code> groups undo operations + @param aFlag \c YES groups undo operations */ - (void)setGroupsByEvent:(BOOL)aFlag { @@ -502,7 +502,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey", } /*! - Returns <code>YES</code> if undo registration is enabled. + Returns \c YES if undo registration is enabled. */ - (BOOL)isUndoRegistrationEnabled { @@ -511,7 +511,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey", // Checking Whether Undo or Redo Is Being Performed /*! - Returns <code>YES</code> if the manager is currently performing an undo. + Returns \c YES if the manager is currently performing an undo. */ - (BOOL)isUndoing { @@ -519,7 +519,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey", } /*! - Returns <code>YES</code> if the manager is currently performing a redo. + Returns \c YES if the manager is currently performing a redo. */ - (BOOL)isRedoing { @@ -584,8 +584,8 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey", /*! If the receiver can perform a redo, this method returns the action name previously associated with the top grouping with - <code>-setActionName:</code>. This name should identify the action to be redone. - @return the redo action's name, or <code>nil</code> if no there's no redo on the stack. + \c -setActionName:. This name should identify the action to be redone. + @return the redo action's name, or \c nil if no there's no redo on the stack. */ - (CPString)redoActionName { @@ -595,8 +595,8 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey", /*! If the receiver can perform an undo, this method returns the action name previously associated with the top grouping with - <code>-setActionName:</code>. This name should identify the action to be undone. - @return the undo action name or <code>nil</code> if no if there's no undo on the stack. + \c -setActionName:. This name should identify the action to be undone. + @return the undo action name or \c nil if no if there's no undo on the stack. */ - (CPString)undoActionName { @@ -606,7 +606,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey", // Working With Run Loops /*! Returns the CPRunLoopModes in which the receiver registers - the <code>-endUndoGrouping</code> processing when it <code>-groupsByEvent</code>. + the \c -endUndoGrouping processing when it \c -groupsByEvent. */ - (CPArray)runLoopModes { @@ -615,8 +615,8 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey", /*! Sets the modes in which the receiver registers the calls - with the current run loop to invoke <code>-endUndoGrouping</code> - when it <code>-groupsByEvent</code>. This method first + with the current run loop to invoke \c -endUndoGrouping + when it \c -groupsByEvent. This method first cancels any pending registrations in the old modes and registers the invocation in the new modes. @param modes the modes in which calls are registered Foundation/CPUndoManager.j 3e85bf0e8b3aa0f195ddd6621b1424c1bd966f49 lowell vizon lowell@sierra117.(none) http://github.com/280north/cappuccino/commit/377f331b4775ccc7e30d5ad1c3c5b407be09880c 377f331b4775ccc7e30d5ad1c3c5b407be09880c 2009-08-07T12:50:50-07:00 2009-07-28T02:54:29-07:00 Documentation Edits: Replaced `<code>` and `<pre>` tags with `\c`; this allows monospaced text to be displayed with formatted text without needing a new line. See AppKit/CPView after generating documentation for examples. Also added `-` and `+` signs to the above changes when referring to either an -instanceMethod or a +classMethod. --lowell@cocoastep Signed-off-by: Francisco Ryan Tolmasky I <francisco@280north.com> fd5bc98a9c56de74d4baf4ce0da5be4291cc88b6 Francisco Ryan Tolmasky I francisco@280north.com