Documentation fixups

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@14368 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
CaS 2002-08-29 10:07:51 +00:00
parent e91dadb618
commit 0977a26764
6 changed files with 45 additions and 27 deletions

View file

@ -1,3 +1,12 @@
2002-08-29 Richard Frith-Macdonald <rfm@gnu.org>
* 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 <FredKiefer@gmx.de> 2002-08-28 Fred Kiefer <FredKiefer@gmx.de>
* Source/NSBezierPath.m * Source/NSBezierPath.m

View file

@ -142,11 +142,13 @@ GSCurrentServer(void)
be initialized. Typically these values are specific to the be initialized. Typically these values are specific to the
concrete implementation. The current set of attributes that can be concrete implementation. The current set of attributes that can be
used with GSDisplayServer is. used with GSDisplayServer is.
</p>
<list> <list>
<item>GSDisplayName</item>, <item>GSDisplayName</item>
<item>GSDisplayNumber</item>, <item>GSDisplayNumber</item>
<item>GSScreenNumber</item>, <item>GSScreenNumber</item>
</list> </list>
<p>
GSDisplayName is window server specific and shouldn't be used when GSDisplayName is window server specific and shouldn't be used when
creating a GSDisplayServer (although you can retrieve the value with creating a GSDisplayServer (although you can retrieve the value with
the -attributes method). On X-Windows the value might be set to something the -attributes method). On X-Windows the value might be set to something

View file

@ -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 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. separately. When finished, it returns the state of the session (i.e.
whether it is still running or has been stopped, etc) whether it is still running or has been stopped, etc)
<p>
</p> </p>
<p>
See Also: -runModalForWindow: See Also: -runModalForWindow:
</p> </p>
*/ */
@ -1303,8 +1303,8 @@ See Also: -runModalForWindow:
/** /**
<p> <p>
Returns the window that is part of the current modal session, if any. Returns the window that is part of the current modal session, if any.
<p>
</p> </p>
<p>
See -runModalForWindow: See -runModalForWindow:
</p> </p>
*/ */

View file

@ -66,6 +66,7 @@ static BOOL userFixedCacheNeedsRecomputing = NO;
the class methods listed below for more information. These default the class methods listed below for more information. These default
fonts can be set using the user defaults system. The default fonts can be set using the user defaults system. The default
font names available are: font names available are:
</p>
<list> <list>
<item>NSBoldFont Helvetica-Bold</item> <item>NSBoldFont Helvetica-Bold</item>
<item>NSControlContentFont Helvetica</item> <item>NSControlContentFont Helvetica</item>
@ -79,7 +80,9 @@ static BOOL userFixedCacheNeedsRecomputing = NO;
<item>NSUserFixedPitchFont Courier</item> <item>NSUserFixedPitchFont Courier</item>
<item>NSUserFont Helvetica</item> <item>NSUserFont Helvetica</item>
</list> </list>
The defualt sizes are: <p>
The default sizes are:
</p>
<list> <list>
<item>NSBoldFontSize (none)</item> <item>NSBoldFontSize (none)</item>
<item>NSControlContentFontSize (none)</item> <item>NSControlContentFontSize (none)</item>
@ -94,6 +97,7 @@ static BOOL userFixedCacheNeedsRecomputing = NO;
<item>NSUserFixedPitchFontSize (none)</item> <item>NSUserFixedPitchFontSize (none)</item>
<item>NSUserFontSize (none)</item> <item>NSUserFontSize (none)</item>
</list> </list>
<p>
Font sizes list with (none) default to NSFontSize. Font sizes list with (none) default to NSFontSize.
</p> </p>

View file

@ -76,18 +76,20 @@ typedef struct {
<p> <p>
Styles can be set using the user defaults system. Currently available Styles can be set using the user defaults system. Currently available
styles are styles are
</p>
<list> <list>
<item>NSNextStepInterfaceStyle</item>, <item>NSNextStepInterfaceStyle</item>
<item>NSMacintoshInterfaceStyle</item>, <item>NSMacintoshInterfaceStyle</item>
<item>NSWindows95InterfaceStyle</item>, <item>NSWindows95InterfaceStyle</item>
<item>GSWindowMakerInterfaceStyle</item>. <item>GSWindowMakerInterfaceStyle</item>
</list> </list>
<p>
You can set a default style You can set a default style
for all UI elements using the <code>NSInterfaceStyleDefault</code> key: for all UI elements using the <code>NSInterfaceStyleDefault</code> key:
</p>
<example> <example>
defaults write NSGlobalDomain NSInterfaceStyleDefault GSWindowMakerInterfaceStyle defaults write NSGlobalDomain NSInterfaceStyleDefault GSWindowMakerInterfaceStyle
</example> </example>
</p>
*/ */
extern NSInterfaceStyle extern NSInterfaceStyle
NSInterfaceStyleForKey(NSString *key, NSResponder *responder) NSInterfaceStyleForKey(NSString *key, NSResponder *responder)
@ -99,7 +101,8 @@ NSInterfaceStyleForKey(NSString *key, NSResponder *responder)
*/ */
if (responder) if (responder)
{ {
style = (NSInterfaceStyle)((accessToResponder)responder)->_interface_style; style
= (NSInterfaceStyle)((accessToResponder)responder)->_interface_style;
if (style != NSNoInterfaceStyle) if (style != NSNoInterfaceStyle)
{ {
return style; return style;

View file

@ -22,21 +22,9 @@
License along with this library; see the file COPYING.LIB. License along with this library; see the file COPYING.LIB.
If not, write to the Free Software Foundation, If not, write to the Free Software Foundation,
59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#include <Foundation/NSNotification.h> <chapter>
#include <Foundation/NSValue.h> <heading>Overview of NSTableColumn</heading>
#include <AppKit/NSTableHeaderCell.h>
#include <AppKit/NSTableColumn.h>
#include <AppKit/NSTableView.h>
/**
<unit>
<heading>Class Description</heading>
<p>
NSTableColumn objects represent columns in NSTableViews.
</p>
<section> <section>
<heading>The Column Identifier</heading> <heading>The Column Identifier</heading>
<p> <p>
@ -70,8 +58,20 @@
of this header cell to the desired title. of this header cell to the desired title.
</p> </p>
</section> </section>
</unit> </chapter>
*/ */
#include <Foundation/NSNotification.h>
#include <Foundation/NSValue.h>
#include <AppKit/NSTableHeaderCell.h>
#include <AppKit/NSTableColumn.h>
#include <AppKit/NSTableView.h>
/**
<p>
NSTableColumn objects represent columns in NSTableViews.
</p>
*/
@implementation NSTableColumn @implementation NSTableColumn
/* /*