Improved documentation

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@22036 72102866-910b-0410-8b05-ffd578937521

ChangeLog

@@ -5,6 +5,7 @@
 	* Source/NSTextFieldCell.m: Improved documentation
 	* Source/NSSavePanel.m: Improved documentation
 	* Source/NSOpenPanel.m: Improved documentation
+	* Source/NSApplication.m: Improved documentation
 
 2005-11-17  fabien  <fabien@sonappart.net>
 

Source/NSApplication.m

@@ -1461,7 +1461,7 @@ static NSSize scaledIconSizeForSize(NSSize imageSize)
 
 /**
  * Starts modal event loop for given window, after calling
- * -beginModalSessionForWindow:.  Loop is broken only by stopModal: ,
+ * -beginModalSessionForWindow:.  Loop is broken only by -stopModal ,
  * -stopModalWithCode: , or -abortModal , at which time -endModalSession:
  * is called automatically.
  */
@@ -1660,10 +1660,10 @@ See -runModalForWindow:
     }
 }
 
-/**
- * Stops a running modal session causing -runModalForWindow: or
+/**<p> Stops a running modal session causing -runModalForWindow: or
  * -runModalSession: to return <code>NSRunStoppedResponse</code>.  Use this
- * or -stopModalWithCode: to end a modal session in response to user input.
+ * or -stopModalWithCode: to end a modal session in response to user input.</p>
+ * <p>See Also: -stopModalWithCode:</p>
  */
 - (void) stopModal
 {
@@ -2101,10 +2101,9 @@ IF_NO_GC(NSAssert([event retainCount] > 0, NSInternalInconsistencyException));
   return NO;
 }
 
-/**
-Sets the application's icon. Any windows that use the old application
+/**<p>Sets the application's icon. Any windows that use the old application
 icon image as their mini window image will be updated to use the new
-image.
+image.</p><p>See Also: -applicationIconImage</p>
 */
 - (void) setApplicationIconImage: (NSImage*)anImage
 {
@@ -2132,8 +2131,8 @@ image.
   DESTROY(old_app_icon);
 }
 
-/**
- *  Returns the current icon be used for the application.
+/**<p>Returns the current icon be used for the application.</p>
+   <p>See Also: -setApplicationIconImage:</p>
  */
 - (NSImage*) applicationIconImage
 {
@@ -2153,13 +2152,12 @@ image.
  * Hiding and arranging windows
  */
 
-/**
- * Request this application to "hide" (unmap all windows from the screen
- * except the icon window).  Posts
+/**<p> Request this application to "hide" (unmap all windows from the screen
+ * except the icon window).  Posts 
  * <code>NSApplicationWillHideNotification</code> and
  * <code>NSApplicationDidHideNotification</code>.  On OS X this activates
  * the next app that is running, however on GNUstep this is up to the window
- * manager.
+ * manager.</p><p>See Also: -unhide: -isHidden</p>
  */
 - (void) hide: (id)sender
 {
@@ -2211,16 +2209,16 @@ image.
     }
 }
 
-/**
- * Returns whether app is currently in hidden state.
+/**<p>Returns whether app is currently in hidden state.</p>
+   <p>See Also: -hide: -unhide:</p>
  */
 - (BOOL) isHidden
 {
   return _app_is_hidden;
 }
 
-/**
- *  Unhides and activates this application.
+/**<p>Unhides and activates this application.</p>
+   <p>See Also: -unhideWithoutActivation -hide: -isHidden</p>
  */
 - (void) unhide: (id)sender
 {
@@ -2319,7 +2317,7 @@ image.
 }
 
 /**
- * Returns current main window of this application.  There need not necessarily
+ * Returns current main window of this application. There need not necessarily
  * be a main window, even if app is active, and this should return nil if the
  * app is inactive.
  */
@@ -2932,27 +2930,26 @@ image.
 		  returnTypes: returnTypes];
 }
 
-/**
- * Return the services menu of the receiver.
+/** <p>Returns the services menu of the receiver.</p>
+    <p>See Also: -setServicesMenu:</p>
  */
 - (NSMenu *) servicesMenu
 {
   return [_listener servicesMenu];
 }
 
-/**
- * Returns the services provided previously registered using the
- * -setServicesProvider: method.
+/**<p> Returns the services provided previously registered using the
+ * -setServicesProvider: method.</p><p>See Also: -setServicesProvider:</p>
  */
 - (id) servicesProvider
 {
   return [_listener servicesProvider];
 }
 
-/**
- * Sets the services menu for the receiver.  This should be called, otherwise
+/**<p>ets the services menu for the receiver.  This should be called, otherwise
  * warnings will be generated by the main event loop, which is in charge of
- * updating all menus, including the Services menu.
+ * updating all menus, including the Services menu.</p>
+ * <p>See Also: -servicesMenu</p>
  */
 - (void) setServicesMenu: (NSMenu *)aMenu
 {