Improved documentation

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@22039 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Fabien_ 2005-11-18 15:34:00 +00:00
parent 10afea4cff
commit 9b38137940
2 changed files with 11 additions and 17 deletions

View file

@ -8,6 +8,7 @@
* Source/NSApplication.m: Improved documentation * Source/NSApplication.m: Improved documentation
* Source/NSBitmapImageRep.m: Improved documentation * Source/NSBitmapImageRep.m: Improved documentation
* Source/NSBox.m: Improved documentation * Source/NSBox.m: Improved documentation
* Source/NSBrowserCell.m: Improved documentation
2005-11-17 fabien <fabien@sonappart.net> 2005-11-17 fabien <fabien@sonappart.net>

View file

@ -54,7 +54,7 @@ static NSFont *_leafFont;
/** /**
*<p> TODO Description</p> *<p> TODO Description</p>
*<p>Explain _gsFontifyCells .... *<p>Explain _gsFontifyCells ....</p>
* *
*/ */
@implementation NSBrowserCell @implementation NSBrowserCell
@ -86,8 +86,7 @@ static NSFont *_leafFont;
} }
} }
/** /**<p>Returns the default branch image. Currently, it's an arrow. </p>
*<p>Returns the default branch image. Currently, it's an arrow. </p>
*<p>See Also: +highlightedBranchImage </p> *<p>See Also: +highlightedBranchImage </p>
*/ */
+ (NSImage*) branchImage + (NSImage*) branchImage
@ -95,8 +94,7 @@ static NSFont *_leafFont;
return _branch_image; return _branch_image;
} }
/** /**<p>Returns the default hightlited branch image</p>
*<p>Returns the default hightlited branch image</p>
*<p>See Also: +branchImage</p> *<p>See Also: +branchImage</p>
*/ */
+ (NSImage*) highlightedBranchImage + (NSImage*) highlightedBranchImage
@ -152,8 +150,7 @@ static NSFont *_leafFont;
return c; return c;
} }
/** /**<p>Returns the alternate image in the NSBrowserCell
*<p>Returns the alternate image in the NSBrowserCell
* (used when the cell is highlighted) </p> * (used when the cell is highlighted) </p>
*<p>See Also: -setAlternateImage:</p> *<p>See Also: -setAlternateImage:</p>
*/ */
@ -162,8 +159,7 @@ static NSFont *_leafFont;
return _alternateImage; return _alternateImage;
} }
/** /**<p>Sets the altenate image (used when the cell is highlighted) to anImage
*<p>Sets the altenate image (used when the cell is highlighted) to anImage
*</p><p>See Also: -alternateImage</p> *</p><p>See Also: -alternateImage</p>
*/ */
- (void) setAlternateImage: (NSImage *)anImage - (void) setAlternateImage: (NSImage *)anImage
@ -179,21 +175,19 @@ static NSFont *_leafFont;
return [_colorClass selectedControlColor]; return [_colorClass selectedControlColor];
} }
/** /**<p>Returns whether the browserCell is a leaf. A leaf cell has usually no
* <p>Returns whether the browserCell is a leaf. A leaf cell has usually no
* image. This method is used by NSBrowser in several methods, for example * image. This method is used by NSBrowser in several methods, for example
* to know if a column should be added; when the user selects a browser cell * to know if a column should be added; when the user selects a browser cell
* (a branch or a leaf)</p> * (a branch or a leaf)</p>
* <p>See Also: -setLeaf: TODO more NSBrowser references</p> * <p>See Also: -setLeaf: </p>
*/ */
- (BOOL) isLeaf - (BOOL) isLeaf
{ {
return _browsercell_is_leaf; return _browsercell_is_leaf;
} }
/** /**<p>Sets whether the cell is a leaf. This method is usally used in the
*<p>Sets whether the cell is a leaf. This method is usally used in the * NSBrowser's delegate methods</p>
* NSBrowser delegate methods</p>
*<p>See Also: -isLeaf</p> *<p>See Also: -isLeaf</p>
*/ */
- (void) setLeaf: (BOOL)flag - (void) setLeaf: (BOOL)flag
@ -245,8 +239,7 @@ static NSFont *_leafFont;
_cell.state = NO; _cell.state = NO;
} }
/** /**<p>Highlights the cell and sets the cell's state to YES</p>
*<p>Highlights the cell and sets the cell's state to YES</p>
*<p>See Also: -reset</p> *<p>See Also: -reset</p>
*/ */
- (void) set - (void) set