From 0977a26764a8e093d328fd29c587a1cb367fa037 Mon Sep 17 00:00:00 2001 From: CaS Date: Thu, 29 Aug 2002 10:07:51 +0000 Subject: [PATCH] Documentation fixups git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@14368 72102866-910b-0410-8b05-ffd578937521 --- ChangeLog | 9 +++++++++ Source/GSDisplayServer.m | 8 +++++--- Source/NSApplication.m | 4 ++-- Source/NSFont.m | 6 +++++- Source/NSInterfaceStyle.m | 15 +++++++++------ Source/NSTableColumn.m | 30 +++++++++++++++--------------- 6 files changed, 45 insertions(+), 27 deletions(-) diff --git a/ChangeLog b/ChangeLog index 495f7db62..8cab3e0cd 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,12 @@ +2002-08-29 Richard Frith-Macdonald + + * Source/GSDisplayServer.m: + * Source/NSApplication.m: + * Source/NSFont.m: + * Source/NSInterfaceStyle.m: + * Source/NSTableColumn.m: + Documentation fixups ... correct gsdoc markup etc. + 2002-08-28 Fred Kiefer * Source/NSBezierPath.m diff --git a/Source/GSDisplayServer.m b/Source/GSDisplayServer.m index 870a14ef7..7aae7a6f7 100644 --- a/Source/GSDisplayServer.m +++ b/Source/GSDisplayServer.m @@ -142,11 +142,13 @@ GSCurrentServer(void) be initialized. Typically these values are specific to the concrete implementation. The current set of attributes that can be used with GSDisplayServer is. +

- GSDisplayName, - GSDisplayNumber, - GSScreenNumber, + GSDisplayName + GSDisplayNumber + GSScreenNumber +

GSDisplayName is window server specific and shouldn't be used when creating a GSDisplayServer (although you can retrieve the value with the -attributes method). On X-Windows the value might be set to something diff --git a/Source/NSApplication.m b/Source/NSApplication.m index 708e17a28..900cd5c1c 100644 --- a/Source/NSApplication.m +++ b/Source/NSApplication.m @@ -1177,8 +1177,8 @@ variable. Before processing the event, it makes the session window key and orders the window front, so there is no need to do this separately. When finished, it returns the state of the session (i.e. whether it is still running or has been stopped, etc) -

+

See Also: -runModalForWindow:

*/ @@ -1303,8 +1303,8 @@ See Also: -runModalForWindow: /**

Returns the window that is part of the current modal session, if any. -

+

See -runModalForWindow:

*/ diff --git a/Source/NSFont.m b/Source/NSFont.m index c1096cbf1..ec8265f4b 100644 --- a/Source/NSFont.m +++ b/Source/NSFont.m @@ -66,6 +66,7 @@ static BOOL userFixedCacheNeedsRecomputing = NO; the class methods listed below for more information. These default fonts can be set using the user defaults system. The default font names available are: +

NSBoldFont Helvetica-Bold NSControlContentFont Helvetica @@ -79,7 +80,9 @@ static BOOL userFixedCacheNeedsRecomputing = NO; NSUserFixedPitchFont Courier NSUserFont Helvetica - The defualt sizes are: +

+ The default sizes are: +

NSBoldFontSize (none) NSControlContentFontSize (none) @@ -94,6 +97,7 @@ static BOOL userFixedCacheNeedsRecomputing = NO; NSUserFixedPitchFontSize (none) NSUserFontSize (none) +

Font sizes list with (none) default to NSFontSize.

diff --git a/Source/NSInterfaceStyle.m b/Source/NSInterfaceStyle.m index 0d992bc3d..8a7ea079a 100644 --- a/Source/NSInterfaceStyle.m +++ b/Source/NSInterfaceStyle.m @@ -76,18 +76,20 @@ typedef struct {

Styles can be set using the user defaults system. Currently available styles are +

- NSNextStepInterfaceStyle, - NSMacintoshInterfaceStyle, - NSWindows95InterfaceStyle, - GSWindowMakerInterfaceStyle. + NSNextStepInterfaceStyle + NSMacintoshInterfaceStyle + NSWindows95InterfaceStyle + GSWindowMakerInterfaceStyle +

You can set a default style for all UI elements using the NSInterfaceStyleDefault key: +

defaults write NSGlobalDomain NSInterfaceStyleDefault GSWindowMakerInterfaceStyle -

*/ extern NSInterfaceStyle NSInterfaceStyleForKey(NSString *key, NSResponder *responder) @@ -99,7 +101,8 @@ NSInterfaceStyleForKey(NSString *key, NSResponder *responder) */ if (responder) { - style = (NSInterfaceStyle)((accessToResponder)responder)->_interface_style; + style + = (NSInterfaceStyle)((accessToResponder)responder)->_interface_style; if (style != NSNoInterfaceStyle) { return style; diff --git a/Source/NSTableColumn.m b/Source/NSTableColumn.m index 3be4ec6c5..8d6279593 100644 --- a/Source/NSTableColumn.m +++ b/Source/NSTableColumn.m @@ -22,21 +22,9 @@ License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -*/ -#include -#include -#include -#include -#include - -/** - - Class Description - -

- NSTableColumn objects represent columns in NSTableViews. -

+ + Overview of NSTableColumn
The Column Identifier

@@ -70,8 +58,20 @@ of this header cell to the desired title.

- + */ + +#include +#include +#include +#include +#include + +/** +

+ NSTableColumn objects represent columns in NSTableViews. +

+ */ @implementation NSTableColumn /*