From 7d43b41457795a07a9893d39e5ca317f5a85e322 Mon Sep 17 00:00:00 2001
From: Fabien_ <Fabien_@72102866-910b-0410-8b05-ffd578937521>
Date: Mon, 21 Nov 2005 16:19:41 +0000
Subject: [PATCH] Improved documentation

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@22066 72102866-910b-0410-8b05-ffd578937521
---
 ChangeLog             |  1 +
 Source/NSColorPanel.m | 24 ++++++++++++++++++------
 2 files changed, 19 insertions(+), 6 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index c2550390c..730c7f68e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -6,6 +6,7 @@
 	* Source/NSCell.m : Improved documentation
 	* Source/NSClipView.m : Improved documentation
 	* Source/NSColor.m : Improved documentation
+	* Source/NSColorPanel.m : Improved documentation
 
 2005-11-21  Fred Kiefer <FredKiefer@gmx.de>
 
diff --git a/Source/NSColorPanel.m b/Source/NSColorPanel.m
index 2c6d0964b..c633472ec 100644
--- a/Source/NSColorPanel.m
+++ b/Source/NSColorPanel.m
@@ -380,7 +380,7 @@ static int _gs_gui_color_picker_mode = NSRGBModeColorPanel;
     }
 }
 
-/**<p>Creates ( if needed ) and returns the shared NSColorPanel</p>
+/**<p>Creates ( if needed ) and returns the shared NSColorPanel.</p>
  */
 + (NSColorPanel *)sharedColorPanel
 {
@@ -399,7 +399,7 @@ static int _gs_gui_color_picker_mode = NSRGBModeColorPanel;
   return _gs_gui_color_panel;
 }
 
-/** <p>Returns whether the NSColorPanel has been already created</p>
+/** <p>Returns whether the NSColorPanel has been already created.</p>
  */
 + (BOOL) sharedColorPanelExists
 {
@@ -485,16 +485,15 @@ static int _gs_gui_color_picker_mode = NSRGBModeColorPanel;
 }
 
 /** <p>Returns the NSColorPanel's accessory view if it exists, 
-    nil otherwise</p><p>See Also: -setAccessoryView:</p>    
+    nil otherwise.</p><p>See Also: -setAccessoryView:</p>    
  */
 - (NSView *) accessoryView
 {
   return _accessoryView;
 }
 
-/** <p> Returns whether the NSColorPanel continuously sends the action message.
-    The default is ... </p><p>See Also: -setContinuous:-setAction: -setTarget:
-    </p>
+/** <p> Returns whether the NSColorPanel continuously sends its action message.
+    </p><p>See Also: -setContinuous:-setAction: -setTarget: </p>
  */
 - (BOOL) isContinuous
 {
@@ -528,6 +527,11 @@ static int _gs_gui_color_picker_mode = NSRGBModeColorPanel;
   [_splitView addSubview: _accessoryView];
 }
 
+/**<p>Sets the NSColorPanl action method to <var>aSelector</var> The
+   action message is usally send in -setColor:, when the picker is updated,
+   when a new picker is show, when the alpha is changed or when one of the
+   color well at the bottom is selected</p>
+ */
 - (void) setAction: (SEL)aSelector
 {
   _action = aSelector;
@@ -564,6 +568,9 @@ static int _gs_gui_color_picker_mode = NSRGBModeColorPanel;
     }
 }
 
+/** <p>Sets whether the NSColorPanel shows alpha values and the alpha
+    slider</p><p>See Also: -showsAlpha</p>
+ */
 - (void) setShowsAlpha: (BOOL)flag
 {
   if (flag == _showsAlpha)
@@ -596,11 +603,16 @@ static int _gs_gui_color_picker_mode = NSRGBModeColorPanel;
   [_topView setNeedsDisplay: YES];
 }
 
+/** <p>Sets the target object to <var>anObject</var></p>
+ */
 - (void) setTarget: (id)anObject
 {
   _target = anObject;
 }
 
+/** <p>Returns whether the NSColorPanel shows alpha values and the alpha
+    slider</p><p>See Also: -setShowsAlpha:</p>
+ */
 - (BOOL) showsAlpha
 {
   return _showsAlpha;