diff --git a/AppKit/CPAlert.j b/AppKit/CPAlert.j index 9d7572f57..aa2345014 100644 --- a/AppKit/CPAlert.j +++ b/AppKit/CPAlert.j @@ -56,7 +56,9 @@ var CPAlertWarningImage, CPAlertInformationImage, CPAlertErrorImage; -/* +/*! + @ingroup appkit + CPAlert is an alert panel that can be displayed modally to present the user with a message and one or more options. diff --git a/AppKit/CPAnimation.j b/AppKit/CPAnimation.j index c2e745a6d..77fdaab91 100644 --- a/AppKit/CPAnimation.j +++ b/AppKit/CPAnimation.j @@ -48,7 +48,10 @@ CPAnimationLinear = 3; ACTUAL_FRAME_RATE = 0; -/*! @class CPAnimation +/*! + @ingroup appkit + @class CPAnimation + Manages an animation. Contains timing and progress information. @par Delegate Methods diff --git a/AppKit/CPApplication.j b/AppKit/CPApplication.j index c68941af1..8a3b04522 100644 --- a/AppKit/CPApplication.j +++ b/AppKit/CPApplication.j @@ -41,7 +41,9 @@ CPRunStoppedResponse = -1000; CPRunAbortedResponse = -1001; CPRunContinuesResponse = -1002; -/*! @class CPApplication +/*! + @ingroup appkit + @class CPApplication 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 diff --git a/AppKit/CPBezierPath.j b/AppKit/CPBezierPath.j index da2b71d34..05a156fac 100644 --- a/AppKit/CPBezierPath.j +++ b/AppKit/CPBezierPath.j @@ -32,6 +32,17 @@ var DefaultLineWidth = 1.0; +/*! + @ingroup appkit + @class CPBezierPath + + A CPBezierPath allows you to create paths for drawing to the screen using a simpler API than CoreGraphics. + Paths can form any shape, including regular polgyons like squares and triangles; circles, arcs; or complex + line segments. + + A path can be stroked and filled using the relevant method. The currently active fill and stroke color will + be used, which can be set by calling setFill: and setStroke: on any CPColor object (or set: for both). +*/ @implementation CPBezierPath : CPObject { diff --git a/AppKit/CPButton.j b/AppKit/CPButton.j index 626ac1e3c..ca3dac841 100644 --- a/AppKit/CPButton.j +++ b/AppKit/CPButton.j @@ -95,7 +95,9 @@ CPChangeBackgroundCellMask = CPBackgroundButtonMask; CPButtonStateMixed = CPThemeState("mixed"); -/*! @class CPButton +/*! + @ingroup appkit + @class CPButton CPButton is a subclass of CPControl that intercepts mouse-down events and sends an action message to a diff --git a/AppKit/CPClipView.j b/AppKit/CPClipView.j index abd85eeb9..6349ed58e 100644 --- a/AppKit/CPClipView.j +++ b/AppKit/CPClipView.j @@ -25,7 +25,9 @@ #include "CoreGraphics/CGGeometry.h" -/*! @class CPClipView +/*! + @ingroup appkit + @class CPClipView CPClipView allows you to define a clip rect and display only that portion of its containing view. It is used to hold the document view in a CPScrollView. diff --git a/AppKit/CPCollectionView.j b/AppKit/CPCollectionView.j index bbbd9436e..325175309 100644 --- a/AppKit/CPCollectionView.j +++ b/AppKit/CPCollectionView.j @@ -29,7 +29,9 @@ @import -/*! @class CPCollectionView +/*! + @ingroup appkit + @class CPCollectionView This class displays an array as a grid of objects, where each object is represented by a view. The view is controlled by creating a CPCollectionViewItem and specifying its view, then diff --git a/AppKit/CPColor.j b/AppKit/CPColor.j index ebd8e2a4e..9bd934b90 100644 --- a/AppKit/CPColor.j +++ b/AppKit/CPColor.j @@ -49,7 +49,9 @@ var cachedBlackColor, cachedShadowColor, cachedClearColor; -/*! @code CPColor +/*! + @ingroup appkit + @code CPColor CPColor can be used to represent color in an RGB or HSB model with an optional transparency value.

diff --git a/AppKit/CPColorPanel.j b/AppKit/CPColorPanel.j index 35fb5181a..1dde0cd52 100644 --- a/AppKit/CPColorPanel.j +++ b/AppKit/CPColorPanel.j @@ -52,7 +52,9 @@ CPSliderColorPickerMode = 2; CPColorPickerViewWidth = 265, CPColorPickerViewHeight = 370; -/*! @class CPColorPanel +/*! + @ingroup appkit + @class CPColorPanel CPColorPanel provides a reusable panel that can be used displayed on screen to prompt the user for a color selection. To diff --git a/AppKit/CPColorPicker.j b/AppKit/CPColorPicker.j index 5fafd56e3..eeb0e8c60 100644 --- a/AppKit/CPColorPicker.j +++ b/AppKit/CPColorPicker.j @@ -23,7 +23,9 @@ @import @import "CPColorPanel.j" -/*! @class CPColorPicker +/*! + @ingroup appkit + @class CPColorPicker CPColorPicker is an abstract superclass for all color picker subclasses. If you want a particular color picker, use CPColorPanel's setPickerMode: method. The simplest way to implement your own color picker is to create a subclass of CPColorPicker. */ diff --git a/AppKit/CPColorWell.j b/AppKit/CPColorWell.j index 712923d9d..355f7c739 100644 --- a/AppKit/CPColorWell.j +++ b/AppKit/CPColorWell.j @@ -29,7 +29,9 @@ var _CPColorWellDidBecomeExclusiveNotification = @"_CPColorWellDidBecomeExclusiveNotification"; -/*! @class CPColorWell +/*! + @ingroup appkit + @class CPColorWell CPColorWell is a CPControl for selecting and displaying a single color value. An example of a CPColorWell object (or simply color well) is found in CPColorPanel, which uses a color well to display the current color selection.

diff --git a/AppKit/CPControl.j b/AppKit/CPControl.j index 03bf63d04..9722d059a 100644 --- a/AppKit/CPControl.j +++ b/AppKit/CPControl.j @@ -80,7 +80,9 @@ CPControlTextDidEndEditingNotification = "CPControlTextDidEndEditingNotific var CPControlBlackColor = [CPColor blackColor]; -/*! @class CPControl +/*! + @ingroup appkit + @class CPControl CPControl is an abstract superclass used to implement user interface elements. As a subclass of CPView and CPResponder it has the ability to handle screen drawing and handling user input. */ diff --git a/AppKit/CPCookie.j b/AppKit/CPCookie.j index 8845b3b41..2be313551 100644 --- a/AppKit/CPCookie.j +++ b/AppKit/CPCookie.j @@ -24,7 +24,9 @@ @import -/*! @class CPCookie +/*! + @ingroup appkit + @class CPCookie CPCookie is the Cappuccino interface to a web browser cookie. You can set the name */ @implementation CPCookie : CPObject diff --git a/AppKit/CPDocument.j b/AppKit/CPDocument.j index 3282ba261..b39506c37 100644 --- a/AppKit/CPDocument.j +++ b/AppKit/CPDocument.j @@ -80,7 +80,9 @@ CPDocumentDidFailToSaveNotification = @"CPDocumentDidFailToSaveNotification"; var CPDocumentUntitledCount = 0; -/*! @class CPDocument +/*! + @ingroup appkit + @class CPDocument CPDocument is used to represent a document/file in a Cappuccino application. In a document-based application, generally multiple documents are open simutaneously diff --git a/AppKit/CPDocumentController.j b/AppKit/CPDocumentController.j index dcc3fc7e4..0dff57fad 100644 --- a/AppKit/CPDocumentController.j +++ b/AppKit/CPDocumentController.j @@ -28,7 +28,9 @@ var CPSharedDocumentController = nil; -/*! @class CPDocumentController +/*! + @ingroup appkit + @class CPDocumentController This class is responsible for managing an application's open documents. */ @implementation CPDocumentController : CPObject diff --git a/AppKit/CPEvent.j b/AppKit/CPEvent.j index 630b15699..8185d3a79 100644 --- a/AppKit/CPEvent.j +++ b/AppKit/CPEvent.j @@ -190,7 +190,9 @@ CPDOMEventTouchCancel = "touchcancel"; var _CPEventPeriodicEventPeriod = 0, _CPEventPeriodicEventTimer = nil; -/*! @class CPEvent +/*! + @ingroup appkit + @class CPEvent CPEvent encapsulates the details of a Cappuccino keyboard or mouse event. */ @implementation CPEvent : CPObject diff --git a/AppKit/CPFlashMovie.j b/AppKit/CPFlashMovie.j index c1998bb10..ef6298fc6 100644 --- a/AppKit/CPFlashMovie.j +++ b/AppKit/CPFlashMovie.j @@ -22,7 +22,9 @@ @import -/*! @class CPFlashMovie +/*! + @ingroup appkit + @class CPFlashMovie CPFlashMovie is used to represent a Flash movie in the Cappuccino framework. */ diff --git a/AppKit/CPFlashView.j b/AppKit/CPFlashView.j index 1df332902..874614b7a 100644 --- a/AppKit/CPFlashView.j +++ b/AppKit/CPFlashView.j @@ -24,7 +24,9 @@ @import "CPFlashMovie.j" @import "CPView.j" - +/*! + @ingroup appkit +*/ @implementation CPFlashView : CPView { CPFlashMovie _flashMovie; diff --git a/AppKit/CPFont.j b/AppKit/CPFont.j index 49439ca54..b511326f5 100644 --- a/AppKit/CPFont.j +++ b/AppKit/CPFont.j @@ -25,7 +25,9 @@ var _CPFonts = {}; #define _CPCachedFont(aName, aSize, isBold) _CPFonts[(isBold ? @"bold " : @"") + ROUND(aSize) + @"px '" + aName + @"'"] -/*! @class CPFont +/*! + @ingroup appkit + @class CPFont The CPFont class allows control of the fonts used for displaying text anywhere on the screen. The primary method for getting a particular font is through one of the class methods that take a name and/or size as arguments, and return the appropriate CPFont. */ diff --git a/AppKit/CPFontManager.j b/AppKit/CPFontManager.j index 607bdbf1a..e95057b99 100644 --- a/AppKit/CPFontManager.j +++ b/AppKit/CPFontManager.j @@ -28,6 +28,9 @@ var CPSharedFontManager = nil, CPFontManagerFactory = Nil; +/*! + @ingroup appkit +*/ @implementation CPFontManager : CPObject { CPArray _availableFonts; diff --git a/AppKit/CPGeometry.j b/AppKit/CPGeometry.j index a87ad1b8d..c49ec1e4d 100644 --- a/AppKit/CPGeometry.j +++ b/AppKit/CPGeometry.j @@ -33,6 +33,11 @@ CPMakePoint = CGPointMake; CPMakeSize = CGSizeMake; CPMakeRect = CGRectMake; +/*! + @addtogroup appkit + @{ +*/ + /*! Creates a copy of a specified point and returns the copy @group CGPoint @@ -498,3 +503,7 @@ function CPPointMakeZero() { return CPPointMake(0, 0, 0); } + +/*! + @} +*/ diff --git a/AppKit/CPGraphicsContext.j b/AppKit/CPGraphicsContext.j index 6185a26f5..60d6d35b9 100644 --- a/AppKit/CPGraphicsContext.j +++ b/AppKit/CPGraphicsContext.j @@ -23,6 +23,7 @@ var CPGraphicsContextCurrent = nil; /*! + @ingroup appkit Provides an interface for drawing to the screen. */ @implementation CPGraphicsContext : CPObject diff --git a/AppKit/CPImage.j b/AppKit/CPImage.j index 0f2249d60..4962912bf 100644 --- a/AppKit/CPImage.j +++ b/AppKit/CPImage.j @@ -58,7 +58,9 @@ function CPImageInBundle(aFilename, aSize, aBundle) @end -/*! @class CPImage +/*! + @ingroup appkit + @class CPImage CPImage is used to represent images in the Cappuccino framework. It supports loading all image types supported by the browser. diff --git a/AppKit/CPImageView.j b/AppKit/CPImageView.j index aa9d12332..ceec7c59d 100644 --- a/AppKit/CPImageView.j +++ b/AppKit/CPImageView.j @@ -58,7 +58,9 @@ var LEFT_SHADOW_INSET = 3.0, VERTICAL_SHADOW_INSET = TOP_SHADOW_INSET + BOTTOM_SHADOW_INSET, HORIZONTAL_SHADOW_INSET = LEFT_SHADOW_INSET + RIGHT_SHADOW_INSET; -/*! @class CPImageView +/*! + @ingroup appkit + @class CPImageView This class is a control that displays an image. */ diff --git a/AppKit/CPMenu.j b/AppKit/CPMenu.j index 4f4d985bb..06784c1db 100644 --- a/AppKit/CPMenu.j +++ b/AppKit/CPMenu.j @@ -48,9 +48,12 @@ var _CPMenuBarVisible = NO, _CPMenuBarAttributes = nil, _CPMenuBarSharedWindow = nil; -/*! @class CPMenu +/*! + @ingroup appkit + @class CPMenu - Menus provide the user with a list of actions and/or submenus. Submenus themselves are full fledged menus and so a heirarchical structure appears. + Menus provide the user with a list of actions and/or submenus. Submenus themselves are full fledged menus + and so a heirarchical structure appears. */ @implementation CPMenu : CPObject { diff --git a/AppKit/CPMenuItem.j b/AppKit/CPMenuItem.j index cf32d3241..454804eb2 100644 --- a/AppKit/CPMenuItem.j +++ b/AppKit/CPMenuItem.j @@ -28,7 +28,9 @@ @import @import -/*! @class CPMenuItem +/*! + @ingroup appkit + @class CPMenuItem A CPMenuItem is added to a CPMenu. It has an action and a target for that action to be sent to diff --git a/AppKit/CPPanel.j b/AppKit/CPPanel.j index 72c7c9712..bcff72814 100644 --- a/AppKit/CPPanel.j +++ b/AppKit/CPPanel.j @@ -26,7 +26,9 @@ CPOKButton = 1; CPCancelButton = 0; -/*! @class CPPanel +/*! + @ingroup appkit + @class CPPanel The CPPanel class defines objects that manage the panels of the Cappuccino user interface. A panel is a window that serves an auxiliary function within an application. It generally displays controls that the user can act on to give instructions to the application or to modify the contents of a standard window.

diff --git a/AppKit/CPPasteboard.j b/AppKit/CPPasteboard.j index 42f136e68..d0bb5f89a 100644 --- a/AppKit/CPPasteboard.j +++ b/AppKit/CPPasteboard.j @@ -42,7 +42,9 @@ CPImagePboardType = @"CPImagePboardType"; var CPPasteboards = nil; -/*! @class CPPasteboard +/*! + @ingroup appkit + @class CPPasteboard CPPasteBoard is the object responsible for cut/copy/paste and drag&drop operations. */ diff --git a/AppKit/CPPopUpButton.j b/AppKit/CPPopUpButton.j index 7ac5901f5..eeaa785b7 100644 --- a/AppKit/CPPopUpButton.j +++ b/AppKit/CPPopUpButton.j @@ -32,7 +32,9 @@ var VISIBLE_MARGIN = 7.0; CPPopUpButtonStatePullsDown = CPThemeState("pulls-down"); -/*! @class CPPopUpButton +/*! + @ingroup appkit + @class CPPopUpButton A CPPopUpButton contains a pop-up menu of items that a user can select from. */ diff --git a/AppKit/CPProgressIndicator.j b/AppKit/CPProgressIndicator.j index 161fd5f63..a5e1756ee 100644 --- a/AppKit/CPProgressIndicator.j +++ b/AppKit/CPProgressIndicator.j @@ -49,7 +49,9 @@ var CPProgressIndicatorSpinningStyleColors = nil, CPProgressIndicatorStyleIdentifiers = nil, CPProgressIndicatorStyleSizes = nil; -/*! @class CPProgressIndicator +/*! + @ingroup appkit + @class CPProgressIndicator This class is used in a Cappuccino GUI to display the progress of a function or task. If the duration of the task is unknown, there is diff --git a/AppKit/CPRadio.j b/AppKit/CPRadio.j index 9212c3de3..f6079c74d 100644 --- a/AppKit/CPRadio.j +++ b/AppKit/CPRadio.j @@ -25,7 +25,43 @@ @import "CPButton.j" +/*! + @ingroup appkit + + from this mailing list thread: + http://groups.google.com/group/objectivej/browse_thread/thread/7c41cbd9cbee9ea3 + + ----------------------------------- + + Creating a checkbox is easy enough: + + checkbox = [[CPCheckBox alloc] initWithFrame:aFrame]; + + That's basically all there is to it. Radio buttons are very similar, + the key difference is the introduction of a new class CPRadioGroup, + which defines which radio buttons are part of the same group: + + [myRadioButton setRadioGroup:aRadioGroup]; + + Every radio button receives a unique radio group by default (so if you + do nothing further, they will all behave independently), but you can + use an existing radio button's group with other buttons as so: + + button1 = [[CPRadio alloc] initWithFrame:aFrame]; + ... + button2 = [[CPRadio alloc] initWithFrame:aFrame radioGroup:[button1 + radioGroup]]; + ... + button3 = [[CPRadio alloc] initWithFrame:aFrame radioGroup:[button1 + radioGroup]]; + ...etc... + + Here, all the radio buttons will act "together". [[button1 radioGroup] + allRadios] returns every button that's part of this group, and + [[button1 radioGroup] selectedRadio] returns the currently selected + option. +*/ @implementation CPRadio : CPButton { CPRadioGroup _radioGroup; diff --git a/AppKit/CPResponder.j b/AppKit/CPResponder.j index 5227a5291..5d07e987b 100644 --- a/AppKit/CPResponder.j +++ b/AppKit/CPResponder.j @@ -33,6 +33,7 @@ CPRightArrowKeyCode = 39; CPDownArrowKeyCode = 40; /*! + @ingroup appkit @class CPResponder Subclasses of CPResonder can be part of the responder chain. diff --git a/AppKit/CPScrollView.j b/AppKit/CPScrollView.j index 40bae8fba..9b92c6032 100644 --- a/AppKit/CPScrollView.j +++ b/AppKit/CPScrollView.j @@ -27,7 +27,9 @@ #include "CoreGraphics/CGGeometry.h" -/*! @class CPScrollView +/*! + @ingroup appkit + @class CPScrollView Used to display views that are too large for the viewing area. the CPScrollView places scroll bars on the side of the view to allow the user to scroll and see the entire diff --git a/AppKit/CPScroller.j b/AppKit/CPScroller.j index f4721f7e5..8f051900a 100644 --- a/AppKit/CPScroller.j +++ b/AppKit/CPScroller.j @@ -41,8 +41,9 @@ CPNoScrollerParts = 0; CPOnlyScrollerArrows = 1; CPAllScrollerParts = 2; -/*! @class CPScroller - +/*! + @ingroup appkit + @class CPScroller */ var PARTS_ARRANGEMENT = [CPScrollerKnobSlot, CPScrollerDecrementLine, CPScrollerIncrementLine, CPScrollerKnob], diff --git a/AppKit/CPSecureTextField.j b/AppKit/CPSecureTextField.j index 5c7602ef9..35792a375 100644 --- a/AppKit/CPSecureTextField.j +++ b/AppKit/CPSecureTextField.j @@ -1,7 +1,9 @@ @import "CPTextField.j" - +/*! + @ingroup appkit +*/ @implementation CPSecureTextField : CPTextField { } diff --git a/AppKit/CPSegmentedControl.j b/AppKit/CPSegmentedControl.j index 411baa18c..ee1ec2118 100644 --- a/AppKit/CPSegmentedControl.j +++ b/AppKit/CPSegmentedControl.j @@ -42,7 +42,9 @@ CPSegmentSwitchTrackingSelectAny = 1; */ CPSegmentSwitchTrackingMomentary = 2; -/*! @class CPSegmentedControl +/*! + @ingroup appkit + @class CPSegmentedControl This class is a horizontal button with multiple segments. */ diff --git a/AppKit/CPShadow.j b/AppKit/CPShadow.j index ffd825bbf..330b85d05 100644 --- a/AppKit/CPShadow.j +++ b/AppKit/CPShadow.j @@ -23,7 +23,9 @@ @import -/*! @class CPShadow +/*! + @deprecated + @class CPShadow Instances of this class contain the attributes of a drop shadow used in Cappuccino. */ diff --git a/AppKit/CPShadowView.j b/AppKit/CPShadowView.j index 8b31ad4e3..36cfabdad 100644 --- a/AppKit/CPShadowView.j +++ b/AppKit/CPShadowView.j @@ -46,6 +46,10 @@ var LIGHT_LEFT_INSET = 3.0, HEAVY_TOP_INSET = 5.0, HEAVY_BOTTOM_INSET = 5.0; +/*! + @ingroup appkit +*/ + @implementation CPShadowView : CPView { CPShadowWeight _weight; diff --git a/AppKit/CPSlider.j b/AppKit/CPSlider.j index 63104618b..b4564a705 100644 --- a/AppKit/CPSlider.j +++ b/AppKit/CPSlider.j @@ -29,6 +29,10 @@ CPLinearSlider = 0; CPCircularSlider = 1; +/*! + @ingroup appkit +*/ + @implementation CPSlider : CPControl { double _minValue; diff --git a/AppKit/CPSplitView.j b/AppKit/CPSplitView.j index 38d001f14..533e74198 100644 --- a/AppKit/CPSplitView.j +++ b/AppKit/CPSplitView.j @@ -34,6 +34,10 @@ CPSplitViewWillResizeSubviewsNotification = @"CPSplitViewWillResizeSubviewsNotif var CPSplitViewHorizontalImage = nil, CPSplitViewVerticalImage = nil; +/*! + @ingroup appkit +*/ + @implementation CPSplitView : CPView { id _delegate; diff --git a/AppKit/CPTabView.j b/AppKit/CPTabView.j index 399e94426..66ad3d3e6 100644 --- a/AppKit/CPTabView.j +++ b/AppKit/CPTabView.j @@ -69,7 +69,9 @@ var CPTabViewDidSelectTabViewItemSelector = 1, CPTabViewWillSelectTabViewItemSelector = 4, CPTabViewDidChangeNumberOfTabViewItemsSelector = 8; -/*! @class CPTabView +/*! + @ingroup appkit + @class CPTabView This class represents a view that has multiple subviews (CPTabViewItem) presented as individual tabs. Only one CPTabViewItem is shown at a time, and other CPTabViewItems can be made visible diff --git a/AppKit/CPTabViewItem.j b/AppKit/CPTabViewItem.j index 2027daea4..0ebc4a5e0 100644 --- a/AppKit/CPTabViewItem.j +++ b/AppKit/CPTabViewItem.j @@ -44,7 +44,9 @@ CPBackgroundTab = 1; */ CPPressedTab = 2; -/*! @class CPTabView +/*! + @ingroup appkit + @class CPTabViewItem The class representation of an item in a CPTabView. One tab view item can be shown at a time in a CPTabView. diff --git a/AppKit/CPTableColumn.j b/AppKit/CPTableColumn.j index 3cdc65e8f..4484e266d 100644 --- a/AppKit/CPTableColumn.j +++ b/AppKit/CPTableColumn.j @@ -47,7 +47,9 @@ CPTableColumnUserResizingMask = 2; #define PurgableInfoView(anInfo) ((anInfo).view) #define PurgableInfoRow(anInfo) ((anInfo).row) -/*! @class CPTableColumn +/*! + @ingroup appkit + @class CPTableColumn An CPTableColumn object mainly keeps information about the width of the column, its minimum and maximum width; whether the column can be edited or resized; and the cells used to draw the column header and the data in the column. You can change all these attributes of the column by calling the appropriate methods. Please note that the table column does not hold nor has access to the data to be displayed in the column; this data is maintained in the table view's data source.

diff --git a/AppKit/CPTableView.j b/AppKit/CPTableView.j index dd1101aa3..343852bdc 100644 --- a/AppKit/CPTableView.j +++ b/AppKit/CPTableView.j @@ -43,7 +43,13 @@ var _CPTableViewWillDisplayCellSelector = 1 << 0, _CPTableViewHeightOfRowSelector = 1 << 6; /* - CPTableView is located within the AppKit framework and is used to display tables. It uses a delegate model for getting its data i.e. you give it an object that provides it with the data it should display. + @ingroup appkit + + This class is not yet stable. + + CPTableView is located within the AppKit framework and is used to display tables. + It uses a delegate model for getting its data i.e. you give it an object that provides + it with the data it should display. @ignore */ diff --git a/AppKit/CPTextField.j b/AppKit/CPTextField.j index d8b9ebe14..38bb8d2d0 100644 --- a/AppKit/CPTextField.j +++ b/AppKit/CPTextField.j @@ -113,6 +113,7 @@ CPTextFieldStateRounded = CPThemeState("rounded"); CPTextFieldStatePlaceholder = CPThemeState("placeholder"); /*! + @ingroup appkit This control displays editable text in a Cappuccino application. */ @implementation CPTextField : CPControl diff --git a/AppKit/CPTheme.j b/AppKit/CPTheme.j index e0a738339..2a32a9573 100644 --- a/AppKit/CPTheme.j +++ b/AppKit/CPTheme.j @@ -27,6 +27,11 @@ var CPThemesByName = { }, CPThemeDefaultTheme = nil; + +/*! + @ingroup appkit +*/ + @implementation CPTheme : CPObject { CPString _name; diff --git a/AppKit/CPThemeBlend.j b/AppKit/CPThemeBlend.j index b6f981e46..4c46af1c1 100644 --- a/AppKit/CPThemeBlend.j +++ b/AppKit/CPThemeBlend.j @@ -26,6 +26,9 @@ @import @import +/*! + @ingroup appkit +*/ @implementation CPThemeBlend : CPObject { diff --git a/AppKit/CPToolbar.j b/AppKit/CPToolbar.j index 6ca1939ff..7d976b513 100644 --- a/AppKit/CPToolbar.j +++ b/AppKit/CPToolbar.j @@ -54,6 +54,7 @@ var CPToolbarsByIdentifier = nil; var CPToolbarConfigurationsByIdentifier = nil; /*! + @ingroup appkit @class CPToolbar A CPToolbar is displayed at the top of a window with multiple diff --git a/AppKit/CPToolbarItem.j b/AppKit/CPToolbarItem.j index 1e5bcda53..b0d9f9c47 100644 --- a/AppKit/CPToolbarItem.j +++ b/AppKit/CPToolbarItem.j @@ -56,7 +56,9 @@ CPToolbarShowFontsItemIdentifier = @"CPToolbarShowFontsItemIdentifier"; CPToolbarCustomizeToolbarItemIdentifier = @"CPToolbarCustomizeToolbarItemIdentifier"; CPToolbarPrintItemIdentifier = @"CPToolbarPrintItemIdentifier"; -/*! @class CPToolbarItem +/*! + @ingroup appkit + @class CPToolbarItem A representation of an item in a CPToolbar. */ diff --git a/AppKit/CPView.j b/AppKit/CPView.j index 561ce0194..4dc5dc61d 100644 --- a/AppKit/CPView.j +++ b/AppKit/CPView.j @@ -100,7 +100,9 @@ var DOMElementPrototype = nil, CustomLayoutSubviewsViews = {}; #endif -/*! @class CPView +/*! + @ingroup appkit + @class CPView

CPView is a class which provides facilities for drawing in a window and receiving events. It is the superclass of many of the visual diff --git a/AppKit/CPWebView.j b/AppKit/CPWebView.j index a36bb5082..e3127df78 100644 --- a/AppKit/CPWebView.j +++ b/AppKit/CPWebView.j @@ -42,6 +42,10 @@ CPWebViewScrollNative = 2; // FIXME: somehow make CPWebView work with CPScrollView instead of native scrollbars (is this even possible?) +/*! + @ingroup appkit +*/ + @implementation CPWebView : CPView { CPScrollView _scrollView; diff --git a/AppKit/CPWindow/CPWindow.j b/AppKit/CPWindow/CPWindow.j index e8eeeee05..a2dd7d717 100644 --- a/AppKit/CPWindow/CPWindow.j +++ b/AppKit/CPWindow/CPWindow.j @@ -187,7 +187,9 @@ var SHADOW_MARGIN_LEFT = 20.0, var CPWindowSaveImage = nil, CPWindowSavingImage = nil; -/*! @class CPWindow +/*! + @ingroup appkit + @class CPWindow An CPWindow instance represents a window, panel or menu on the screen.

diff --git a/AppKit/CPWindowController.j b/AppKit/CPWindowController.j index 9bf09717b..35bc94c90 100644 --- a/AppKit/CPWindowController.j +++ b/AppKit/CPWindowController.j @@ -30,7 +30,9 @@ #include "Platform/Platform.h" -/*! @class CPWindowController +/*! + @ingroup appkit + @class CPWindowController An instance of a CPWindowController manages a CPWindow. It has methods that get called when the window is loading, and after the window has loaded. In the diff --git a/AppKit/Cib/CPCib.j b/AppKit/Cib/CPCib.j index c21b3c354..2e44da5e6 100644 --- a/AppKit/Cib/CPCib.j +++ b/AppKit/Cib/CPCib.j @@ -38,6 +38,10 @@ CPCibReplacementClasses = @"CPCibReplacementClasses"; var CPCibObjectDataKey = @"CPCibObjectDataKey"; +/*! + @ingroup appkit +*/ + @implementation CPCib : CPObject { CPData _data; diff --git a/AppKit/CoreGraphics/CGContext.j b/AppKit/CoreGraphics/CGContext.j index 2e883ec61..ba034d66f 100644 --- a/AppKit/CoreGraphics/CGContext.j +++ b/AppKit/CoreGraphics/CGContext.j @@ -74,6 +74,11 @@ kCGBlendModeXOR = 25; kCGBlendModePlusDarker = 26; kCGBlendModePlusLighter = 27; +/*! + @defgroup coregraphics CoreGraphics + @{ +*/ + /*! This function is just here for source compatability. It does nothing. @@ -94,9 +99,15 @@ function CGContextRetain(aContext) return aContext; } +/*! +@cond +*/ // BEGIN CANVAS IF if (!CPFeatureIsCompatible(CPHTMLCanvasFeature)) { +/*! +@endcond +*/ /*! Creates a new graphics state, which describes all the current values for drawing. @@ -498,7 +509,13 @@ function CGContextSetAlpha(aContext, anAlpha) aContext.gState.alpha = MAX(MIN(anAlpha, 1.0), 0.0); } +/*! +@cond +*/ } // END CANVAS IF +/*! +@endcond +*/ // GOOD. /*! @@ -662,6 +679,13 @@ function CGContextStrokeRoundedRectangleInRect(aContext, aRect, aRadius, ne, se, CGContextStrokePath(aContext); } +/*! + @} +*/ + +/*! +@cond +*/ if (CPFeatureIsCompatible(CPHTMLCanvasFeature)) { #include "CGContextCanvas.j" @@ -670,3 +694,6 @@ else if (CPFeatureIsCompatible(CPVMLFeature)) { #include "CGContextVML.j" } +/*! +@endcond +*/ diff --git a/AppKit/CoreGraphics/CGGeometry.j b/AppKit/CoreGraphics/CGGeometry.j index 76e732ed6..78eedcf91 100644 --- a/AppKit/CoreGraphics/CGGeometry.j +++ b/AppKit/CoreGraphics/CGGeometry.j @@ -70,6 +70,11 @@ _function(CGInsetMakeZero()) _function(CGInsetMakeCopy(anInset)) _function(CGInsetIsEmpty(anInset)) +/*! + @addtogroup appkit + @{ +*/ + /*! Returns a BOOL indicating whether CGRect lhsRect contains CGRect rhsRect. @@ -223,3 +228,6 @@ function CPStringFromCGInset(anInset) return '{' + anInset.top + ", " + anInset.left + ", " + anInset.bottom + ", " + anInset.right + '}'; } +/*! + @} +*/ diff --git a/AppKit/CoreGraphics/CGPath.j b/AppKit/CoreGraphics/CGPath.j index 1b49f079c..017317c3f 100644 --- a/AppKit/CoreGraphics/CGPath.j +++ b/AppKit/CoreGraphics/CGPath.j @@ -36,6 +36,11 @@ kCGPathElementCloseSubpath = 4; kCGPathElementAddArc = 5; kCGPathElementAddArcToPoint = 6; +/*! + @addtogroup coregraphics + @{ +*/ + /*! Returns a new CGPath object. */ @@ -368,3 +373,8 @@ function CGPathIsEmpty(aPath) { return !aPath || aPath.count == 0; } + +/*! + @} +*/ + diff --git a/Foundation/CPArray.j b/Foundation/CPArray.j index fa8e3e73e..0ebc6db05 100755 --- a/Foundation/CPArray.j +++ b/Foundation/CPArray.j @@ -86,7 +86,9 @@ @end -/*! @class CPArray +/*! + @ingroup foundation + @class CPArray A mutable array class backed by a JavaScript Array. There is also a CPMutableArray class, but it is just a child class of this class with an diff --git a/Foundation/CPBundle.j b/Foundation/CPBundle.j index d24a5f0c4..2e6949292 100644 --- a/Foundation/CPBundle.j +++ b/Foundation/CPBundle.j @@ -25,6 +25,9 @@ @import "CPURLRequest.j" +/*! + @ingroup foundation +*/ @implementation CPBundle : CPObject { diff --git a/Foundation/CPCoder.j b/Foundation/CPCoder.j index 6939068ef..a6f8105bc 100644 --- a/Foundation/CPCoder.j +++ b/Foundation/CPCoder.j @@ -24,7 +24,9 @@ @import "CPException.j" -/*! @class CPCoder +/*! + @ingroup foundation + @class CPCoder Top-level class defining methods for use when archiving (encoding) objects to a byte array or file, and when restoring (decoding) objects. */ diff --git a/Foundation/CPCountedSet.j b/Foundation/CPCountedSet.j index 80cae049a..eb1ec3517 100644 --- a/Foundation/CPCountedSet.j +++ b/Foundation/CPCountedSet.j @@ -1,6 +1,9 @@ @import "CPSet.j" +/*! + @ingroup foundation +*/ @implementation CPCountedSet : CPMutableSet { Object _counts; diff --git a/Foundation/CPData.j b/Foundation/CPData.j index 8acbc95fa..b77fbf4be 100644 --- a/Foundation/CPData.j +++ b/Foundation/CPData.j @@ -23,6 +23,9 @@ @import "CPObject.j" @import "CPString.j" +/*! + @ingroup foundation +*/ @implementation CPData : CPObject { diff --git a/Foundation/CPDate.j b/Foundation/CPDate.j index cf893248e..f46dced2f 100644 --- a/Foundation/CPDate.j +++ b/Foundation/CPDate.j @@ -26,6 +26,9 @@ var CPDateReferenceDate = new Date(Date.UTC(2001,1,1,0,0,0,0)); +/*! + @ingroup foundation +*/ @implementation CPDate : CPObject { } diff --git a/Foundation/CPDictionary.j b/Foundation/CPDictionary.j index 8081f109e..acdd56eae 100755 --- a/Foundation/CPDictionary.j +++ b/Foundation/CPDictionary.j @@ -57,7 +57,9 @@ @end -/*! @class CPDictionary +/*! + @ingroup foundation + @class CPDictionary A dictionary is the standard way of passing around key-value pairs in the Cappuccino framework. It is similar to the Java map interface, diff --git a/Foundation/CPEnumerator.j b/Foundation/CPEnumerator.j index a7cf7b09b..63e88d424 100755 --- a/Foundation/CPEnumerator.j +++ b/Foundation/CPEnumerator.j @@ -22,6 +22,9 @@ @import "CPObject.j" +/*! + @ingroup foundation +*/ /*! @class CPEnumerator CPEnumerator is a superclass (with useless method bodies) diff --git a/Foundation/CPException.j b/Foundation/CPException.j index e6b615f4d..f948902ab 100755 --- a/Foundation/CPException.j +++ b/Foundation/CPException.j @@ -30,7 +30,9 @@ CPUnsupportedMethodException = "CPUnsupportedMethodException"; CPRangeException = "CPRangeException"; CPInternalInconsistencyException = "CPInternalInconsistencyException"; -/*! @class CPException +/*! + @ingroup foundation + @class CPException An example of throwing an exception in Objective-J:
 // some code here...
diff --git a/Foundation/CPIndexSet.j b/Foundation/CPIndexSet.j
index d4df88094..a5d892da7 100644
--- a/Foundation/CPIndexSet.j
+++ b/Foundation/CPIndexSet.j
@@ -24,7 +24,9 @@
 @import "CPObject.j"
 
 
-/*! @class CPIndexSet
+/*! 
+    @ingroup foundation
+    @class CPIndexSet
     Instances of this class are collections of numbers. Each integer can appear in a collection only once.
 */
 @implementation CPIndexSet : CPObject
diff --git a/Foundation/CPInvocation.j b/Foundation/CPInvocation.j
index 802188778..0ad03d9a9 100644
--- a/Foundation/CPInvocation.j
+++ b/Foundation/CPInvocation.j
@@ -24,7 +24,9 @@
 @import "CPException.j"
 
 
-/*! @class CPInvocation
+/*! 
+    @ingroup foundation
+    @class CPInvocation
     A CPInvocation is an object representation of a message sent to an object.
 */
 @implementation CPInvocation : CPObject
diff --git a/Foundation/CPJSONPConnection.j b/Foundation/CPJSONPConnection.j
index 6e54213d7..480844b1f 100644
--- a/Foundation/CPJSONPConnection.j
+++ b/Foundation/CPJSONPConnection.j
@@ -25,6 +25,10 @@
 
 CPJSONPConnectionCallbacks = {};
 
+/*! 
+    @ingroup foundation
+*/
+
 /*! @class CPJSONPConnection
     Important note: CPJSONPConnection is only for JSONP APIs.
     If aren't sure you need
diff --git a/Foundation/CPKeyedArchiver.j b/Foundation/CPKeyedArchiver.j
index 618e3ae7d..7b1eb0b9d 100644
--- a/Foundation/CPKeyedArchiver.j
+++ b/Foundation/CPKeyedArchiver.j
@@ -60,7 +60,9 @@ var _CPKeyedArchiverStringClass                         = Nil,
 }
 @end
 
-/*! @class CPKeyedArchiver
+/*! 
+    @ingroup foundation
+    @class CPKeyedArchiver
 
     Implements keyed archiving of object graphs. Archiving means to
     write data out in a format that be read in again later, or possibly
@@ -95,6 +97,7 @@ var _CPKeyedArchiverStringClass                         = Nil,
     @param object the object to be replaced
     @param newObject the replacement object
 */
+
 @implementation CPKeyedArchiver : CPCoder
 {
     id                      _delegate;
diff --git a/Foundation/CPKeyedUnarchiver.j b/Foundation/CPKeyedUnarchiver.j
index 6e49d6822..467737b2d 100644
--- a/Foundation/CPKeyedUnarchiver.j
+++ b/Foundation/CPKeyedUnarchiver.j
@@ -50,7 +50,9 @@ var _CPKeyedUnarchiverArrayClass                                            = Ni
     _CPKeyedUnarchiverDataClass                                             = Nil,
     _CPKeyedUnarchiverArchiverValueClass                                    = Nil;
 
-/*
+/*!
+    @ingroup foundation
+
     CPKeyedUnarchiver is used for creating objects out of
     coded files or CPData objects that were created by
     CPKeyedArchiver. More specifically, this class unarchives
diff --git a/Foundation/CPNotification.j b/Foundation/CPNotification.j
index aa6513e65..f01e3a557 100644
--- a/Foundation/CPNotification.j
+++ b/Foundation/CPNotification.j
@@ -24,7 +24,9 @@
 @import "CPException.j"
 
 
-/*! @class CPNotification
+/*! 
+    @ingroup foundation
+    @class CPNotification
     Represents a notification for posting to an CPNotificationCenter. Consists of a name, an object, and an optional dictionary. The notification center will check for observers registered to receive either notifications with the name, the object, or both and pass the notification instance on to them.
 
     To create a notification use one of the class methods. The default init method will throw a
diff --git a/Foundation/CPNotificationCenter.j b/Foundation/CPNotificationCenter.j
index 375ff855c..7b60b1f82 100644
--- a/Foundation/CPNotificationCenter.j
+++ b/Foundation/CPNotificationCenter.j
@@ -25,6 +25,9 @@
 @import "CPNotification.j"
 @import "CPException.j"
 
+/*! 
+    @ingroup foundation
+*/
 
 var CPNotificationDefaultCenter = nil;
 
diff --git a/Foundation/CPNull.j b/Foundation/CPNull.j
index 0f1c55081..95a0122d4 100644
--- a/Foundation/CPNull.j
+++ b/Foundation/CPNull.j
@@ -25,7 +25,9 @@
 
 var CPNullSharedNull = nil;
 
-/*! @class CPNull
+/*! 
+    @ingroup foundation
+    @class CPNull
     This class is used as an object representation of nil. This is handy when a collection
     only accepts objects as values, but you would like a nil representation in there.
 */
diff --git a/Foundation/CPNumber.j b/Foundation/CPNumber.j
index 093e9176a..4a7d70d6e 100644
--- a/Foundation/CPNumber.j
+++ b/Foundation/CPNumber.j
@@ -27,7 +27,9 @@
 var __placeholder = new Number(),
     _CPNumberHashes = { };
 
-/*! @class CPNumber
+/*! 
+    @ingroup foundation
+    @class CPNumber
     This class primarily exists for source compatability. The JavaScript
     Number type can be changed on the fly based on context,
     so there is no need to call any of these methods. 
diff --git a/Foundation/CPObject.j b/Foundation/CPObject.j
index b222b8ebf..a265dd95d 100644
--- a/Foundation/CPObject.j
+++ b/Foundation/CPObject.j
@@ -21,6 +21,7 @@
  */
 
 /*!
+    @ingroup foundation
     @class CPObject
     
     CPObject is the root class for most Cappuccino classes. Like in Objective-C,
diff --git a/Foundation/CPRange.j b/Foundation/CPRange.j
index 2d6519784..aa446f77f 100755
--- a/Foundation/CPRange.j
+++ b/Foundation/CPRange.j
@@ -20,6 +20,11 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/*!
+    @addtogroup foundation
+    @{
+*/
+
 /*!
     Makes a CPRange.
     @param location the location for new range
@@ -164,3 +169,7 @@ function CPRangeFromString(aString)
     
     return { location:parseInt(aString.substr(1, comma - 1)), length:parseInt(aString.substring(comma + 1, aString.length)) };
 }
+
+/*!
+    @}
+*/
diff --git a/Foundation/CPRunLoop.j b/Foundation/CPRunLoop.j
index 58d80f8cb..f79dba058 100644
--- a/Foundation/CPRunLoop.j
+++ b/Foundation/CPRunLoop.j
@@ -137,7 +137,9 @@ var _CPRunLoopPerformPool           = [],
 
 var CPRunLoopLastNativeRunLoop = 0;
 
-/*! @class CPRunLoop
+/*! 
+    @ingroup foundation
+    @class CPRunLoop
 
     CPRunLoop instances handle various utility tasks that must be performed repetitively in an application, such as processing input events.
 
diff --git a/Foundation/CPSet.j b/Foundation/CPSet.j
index 6b2abaf53..2983e2136 100644
--- a/Foundation/CPSet.j
+++ b/Foundation/CPSet.j
@@ -14,7 +14,9 @@
 @import "CPNumber.j"
 @import "CPEnumerator.j"
 
-
+/*!
+    @ingroup foundation
+*/
 @implementation CPSet : CPObject
 {
     Object      _contents;
diff --git a/Foundation/CPSortDescriptor.j b/Foundation/CPSortDescriptor.j
index b0bd518f5..6a03406cd 100755
--- a/Foundation/CPSortDescriptor.j
+++ b/Foundation/CPSortDescriptor.j
@@ -43,7 +43,9 @@ CPOrderedSame           =  0;
 */
 CPOrderedDescending     =  1;
 
-/*! @class CPSortDescriptor
+/*! 
+    @ingroup foundation
+    @class CPSortDescriptor
     A CPSortDescriptor holds the attributes necessary to describe how
     to sort a set of objects. The sort descriptor instance holds a property key path
     to the sort item of the objects to compare, the method selector to call for sorting and the sort order.
diff --git a/Foundation/CPString.j b/Foundation/CPString.j
index f0af301e6..803f31fe1 100644
--- a/Foundation/CPString.j
+++ b/Foundation/CPString.j
@@ -58,7 +58,9 @@ CPNumericSearch         = 64;
 
 var CPStringHashes      = new objj_dictionary();
 
-/*! @class CPString
+/*! 
+    @ingroup foundation
+    @class CPString
     CPString is an object that allows management of strings. Because CPString is
     based on the JavaScript String object, CPStrings are immutable, although the
     class does have methods that create new CPStrings generated from modifications to the
diff --git a/Foundation/CPTimer.j b/Foundation/CPTimer.j
index 0e59a9d79..e59ba700b 100644
--- a/Foundation/CPTimer.j
+++ b/Foundation/CPTimer.j
@@ -25,7 +25,9 @@
 @import "CPDate.j"
 @import "CPRunLoop.j"
 
-
+/*! 
+    @ingroup foundation
+*/
 @implementation CPTimer : CPObject
 {
     CPTimeInterval      _timeInterval;
diff --git a/Foundation/CPURLConnection.j b/Foundation/CPURLConnection.j
index 47c458f1a..9865e6d3c 100644
--- a/Foundation/CPURLConnection.j
+++ b/Foundation/CPURLConnection.j
@@ -35,6 +35,8 @@ var XMLHTTPRequestUninitialized = 0,
 var CPURLConnectionDelegate = nil;
 
 /*
+    @ingroup foundation
+
     An interface to downloading content at a specified URL. Using one of the
     class methods, you can obtain the data.
     
diff --git a/Foundation/CPURLRequest.j b/Foundation/CPURLRequest.j
index 99d88ae08..7498a143a 100644
--- a/Foundation/CPURLRequest.j
+++ b/Foundation/CPURLRequest.j
@@ -23,7 +23,9 @@
 @import "CPObject.j"
 
 
-/*! @class CPURLRequest
+/*! 
+    @ingroup foundation
+    @class CPURLRequest
     A helper object for CPURLConnection, that contains
     data obtained during the life of a request.
 */
diff --git a/Foundation/CPURLResponse.j b/Foundation/CPURLResponse.j
index 15bf17f66..0e2159d93 100644
--- a/Foundation/CPURLResponse.j
+++ b/Foundation/CPURLResponse.j
@@ -30,6 +30,7 @@
     CPString    _textEncodingName;
 */
 /*!
+    @ingroup foundation
     Contains protocol agnostic information about a request to a specific URL.
 */
 @implementation CPURLResponse : CPObject
diff --git a/Foundation/CPUndoManager.j b/Foundation/CPUndoManager.j
index e0f3be84e..afba0dbae 100644
--- a/Foundation/CPUndoManager.j
+++ b/Foundation/CPUndoManager.j
@@ -151,7 +151,9 @@ var _CPUndoGroupingParentKey        = @"_CPUndoGroupingParentKey",
 
 @end
 
-/*! @class CPUndoManager
+/*! 
+    @ingroup foundation
+    @class CPUndoManager
     CPUndoManager provides a general mechanism supporting implementation of user action "undo" in applications. Essentially, it allows you to store sequences of messages and receivers that need to be invoked to undo or redo an action. The various methods in this class provide for grouping of sets of actions, 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 [[CPUndoManager alloc] init] message.
 */
 @implementation CPUndoManager : CPObject
diff --git a/Foundation/CPValue.j b/Foundation/CPValue.j
index 87ba270b6..a7d499f1d 100644
--- a/Foundation/CPValue.j
+++ b/Foundation/CPValue.j
@@ -24,7 +24,9 @@
 @import "CPCoder.j"
 
 
-/*! @class CPValue
+/*! 
+    @ingroup foundation
+    @class CPValue
     The class can be subclassed to hold different types of scalar values.
 */
 @implementation CPValue : CPObject
diff --git a/Tools/Documentation/Cappuccino.doxygen b/Tools/Documentation/Cappuccino.doxygen
index 707864f3c..a46c90519 100644
--- a/Tools/Documentation/Cappuccino.doxygen
+++ b/Tools/Documentation/Cappuccino.doxygen
@@ -130,8 +130,7 @@ FILE_PATTERNS          = *.c \
                          *.vhdl \
                          *.j
 RECURSIVE              = YES
-EXCLUDE                = AppKit/Cib \
-                         AppKit/Themes \
+EXCLUDE                = AppKit/Themes \
                          AppKit/CPOutlineView.j \
                          AppKit/CPTableColumn.j \
                          AppKit/CPTableView.j