Improved documentation

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@22065 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Fabien_ 2005-11-21 16:00:16 +00:00
parent a97c10d438
commit f81dd99302
2 changed files with 14 additions and 13 deletions

View file

@ -5,6 +5,7 @@
* Source/NSCachedImageRep.m : Improved documentation * Source/NSCachedImageRep.m : Improved documentation
* Source/NSCell.m : Improved documentation * Source/NSCell.m : Improved documentation
* Source/NSClipView.m : Improved documentation * Source/NSClipView.m : Improved documentation
* Source/NSColor.m : Improved documentation
2005-11-21 Fred Kiefer <FredKiefer@gmx.de> 2005-11-21 Fred Kiefer <FredKiefer@gmx.de>

View file

@ -481,7 +481,7 @@ systemColorWithName(NSString *name)
/**<p>Returns a NSColor in a NSCalibratedWhiteColorSpace space name. /**<p>Returns a NSColor in a NSCalibratedWhiteColorSpace space name.
with white and alpha values set as NSBlack and 1.0 respectively </p> with white and alpha values set as NSBlack and 1.0 respectively.</p>
<p>See Also : +colorWithCalibratedWhite:alpha:</p> <p>See Also : +colorWithCalibratedWhite:alpha:</p>
*/ */
+ (NSColor*) blackColor + (NSColor*) blackColor
@ -492,7 +492,7 @@ systemColorWithName(NSString *name)
/**<p>Returns an NSColor in a NSCalibratedRGBColorSpace space name. /**<p>Returns an NSColor in a NSCalibratedRGBColorSpace space name.
with red, green, blue and alpha values set as 0.0, 0.0, 1.0 and 1.0 with red, green, blue and alpha values set as 0.0, 0.0, 1.0 and 1.0
respectively </p><p>See Also : +colorWithCalibratedRed:green:blue:alpha:</p> respectively.</p><p>See Also : +colorWithCalibratedRed:green:blue:alpha:</p>
*/ */
+ (NSColor*) blueColor + (NSColor*) blueColor
{ {
@ -504,7 +504,7 @@ systemColorWithName(NSString *name)
/**<p>Returns a NSColor in a NSCalibratedRGBColorSpace space name. /**<p>Returns a NSColor in a NSCalibratedRGBColorSpace space name.
with red, green, blue and alpha values set as 0.6, 0.4, 0.2 and 1.0 with red, green, blue and alpha values set as 0.6, 0.4, 0.2 and 1.0
respectively </p><p>See Also: +colorWithCalibratedRed:green:blue:alpha:</p> respectively.</p><p>See Also: +colorWithCalibratedRed:green:blue:alpha:</p>
*/ */
+ (NSColor*) brownColor + (NSColor*) brownColor
{ {
@ -515,7 +515,7 @@ systemColorWithName(NSString *name)
} }
/**<p>Returns a NSColor in a NSCalibratedWhiteColorSpace space name. /**<p>Returns a NSColor in a NSCalibratedWhiteColorSpace space name.
with white and alpha values set as 0.0 and 1.0 respectively </p> with white and alpha values set as 0.0 and 1.0 respectively.</p>
<p>See Also : +colorWithCalibratedWhite:alpha:</p> <p>See Also : +colorWithCalibratedWhite:alpha:</p>
*/ */
+ (NSColor*) clearColor + (NSColor*) clearColor
@ -526,7 +526,7 @@ systemColorWithName(NSString *name)
/**<p>Returns a NSColor in a NSCalibratedRGBColorSpace space name. /**<p>Returns a NSColor in a NSCalibratedRGBColorSpace space name.
with red, green, blue and alpha values set as 0.0, 1.0, 1.0 and 1.0 with red, green, blue and alpha values set as 0.0, 1.0, 1.0 and 1.0
respectively </p><p>See Also : +colorWithCalibratedRed:green:blue:alpha:</p> respectively.</p><p>See Also : +colorWithCalibratedRed:green:blue:alpha:</p>
*/ */
+ (NSColor*) cyanColor + (NSColor*) cyanColor
{ {
@ -537,7 +537,7 @@ systemColorWithName(NSString *name)
} }
/**<p>Returns a NSColor in a NSCalibratedWhiteColorSpace space name. /**<p>Returns a NSColor in a NSCalibratedWhiteColorSpace space name.
with white and alpha values set as NSDarkGray and 1.0 respectively </p> with white and alpha values set as NSDarkGray and 1.0 respectively. </p>
<p>See Also : +colorWithCalibratedWhite:alpha:</p> <p>See Also : +colorWithCalibratedWhite:alpha:</p>
*/ */
+ (NSColor*) darkGrayColor + (NSColor*) darkGrayColor
@ -546,7 +546,7 @@ systemColorWithName(NSString *name)
} }
/**<p>Returns a NSColor in a NSCalibratedWhiteColorSpace space name. /**<p>Returns a NSColor in a NSCalibratedWhiteColorSpace space name.
with white and alpha values set as NSGray and 1.0 respectively </p> with white and alpha values set as NSGray and 1.0 respectively. </p>
<p>See Also: +colorWithCalibratedWhite:alpha:</p> <p>See Also: +colorWithCalibratedWhite:alpha:</p>
*/ */
+ (NSColor*) grayColor + (NSColor*) grayColor
@ -577,7 +577,7 @@ systemColorWithName(NSString *name)
/**<p>Returns a NSColor in a NSCalibratedRGBColorSpace space name. /**<p>Returns a NSColor in a NSCalibratedRGBColorSpace space name.
with red, green, blue and alpha values set as 1.0, 0.0, 1.0 and 1.0 with red, green, blue and alpha values set as 1.0, 0.0, 1.0 and 1.0
respectively </p><p>See Also : +colorWithCalibratedRed:green:blue:alpha:</p> respectively.</p><p>See Also : +colorWithCalibratedRed:green:blue:alpha:</p>
*/ */
+ (NSColor*) magentaColor + (NSColor*) magentaColor
{ {
@ -590,7 +590,7 @@ systemColorWithName(NSString *name)
/**<p>Returns a NSColor in a NSCalibratedRGBColorSpace space name. /**<p>Returns a NSColor in a NSCalibratedRGBColorSpace space name.
with red, green, blue and alpha values set as 1.0, 0.5, 0.0 and 1.0 with red, green, blue and alpha values set as 1.0, 0.5, 0.0 and 1.0
respectively </p><p>See Also: +colorWithCalibratedRed:green:blue:alpha:</p> respectively.</p><p>See Also: +colorWithCalibratedRed:green:blue:alpha:</p>
*/ */
+ (NSColor*) orangeColor + (NSColor*) orangeColor
{ {
@ -603,7 +603,7 @@ systemColorWithName(NSString *name)
/**<p>Returns a NSColor in a NSCalibratedRGBColorSpace space name. /**<p>Returns a NSColor in a NSCalibratedRGBColorSpace space name.
with red, green, blue and alpha values set as 0.5, 0.0, 0.5 and 1.0 with red, green, blue and alpha values set as 0.5, 0.0, 0.5 and 1.0
respectively </p><p>See Also : +colorWithCalibratedRed:green:blue:alpha:</p> respectively.</p><p>See Also : +colorWithCalibratedRed:green:blue:alpha:</p>
*/ */
+ (NSColor*) purpleColor + (NSColor*) purpleColor
{ {
@ -627,7 +627,7 @@ systemColorWithName(NSString *name)
} }
/**<p>Returns a NSColor in a NSCalibratedWhiteColorSpace space name. /**<p>Returns a NSColor in a NSCalibratedWhiteColorSpace space name.
with white and alpha values set as NSWhite and 1.0 respectively </p> with white and alpha values set as NSWhite and 1.0 respectively. </p>
<p>See Also : +colorWithCalibratedWhite:alpha:</p> <p>See Also : +colorWithCalibratedWhite:alpha:</p>
*/ */
+ (NSColor*) whiteColor + (NSColor*) whiteColor
@ -638,7 +638,7 @@ systemColorWithName(NSString *name)
/**<p>Returns a NSColor in a NSCalibratedRGBColorSpace space name. /**<p>Returns a NSColor in a NSCalibratedRGBColorSpace space name.
with red, green, blue and alpha values set as 1.0, 0.0, 0.0 and 1.0 with red, green, blue and alpha values set as 1.0, 0.0, 0.0 and 1.0
respectively </p><p>See Also : +colorWithCalibratedRed:green:blue:alpha:</p> respectively.</p><p>See Also : +colorWithCalibratedRed:green:blue:alpha:</p>
*/ */
+ (NSColor*) yellowColor + (NSColor*) yellowColor
{ {
@ -658,7 +658,7 @@ systemColorWithName(NSString *name)
} }
/** TODO /** TODO
*<p>See Also: +ignoresAlpha:</p> *<p>See Also: +ignoresAlpha</p>
*/ */
+ (void) setIgnoresAlpha: (BOOL)flag + (void) setIgnoresAlpha: (BOOL)flag
{ {