Improved documentation

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

ChangeLog

@@ -2,6 +2,7 @@
 
 	* Source/NSMatrix.m: Improved documentation, various cleanups
 	* Source/NSOpenPanel.m: Improved documentation
+	* Source/NSPageLayout.m: Improved documentation
 
 2005-11-22  Richard Frith-Macdonald <rfm@gnu.org>
 

Source/NSOpenPanel.m

@@ -238,8 +238,8 @@ static NSOpenPanel *_gs_gui_open_panel = nil;
     or NSCancelButton depending on which button the user pressed.
     </p>
     <p>
-    Use the -filename or -filenames method to retrieve the name of the
+    Use the [NSSavePanel-filename] or -filenames method to retrieve
-    file the user selected.
+    the name of the file the user selected.
     </p>
  */
 @implementation NSOpenPanel

Source/NSPageLayout.m

@@ -239,7 +239,8 @@ enum {
 }
 
 
-/** Creates and returns a shared instance of the NSPageLayout panel.
+/** Creates ( if needed )  and returns a shared instance of the
+    NSPageLayout panel.
  */
 + (NSPageLayout *)pageLayout
 {
@@ -256,18 +257,20 @@ enum {
 //
 // Running the Panel 
 //
-/** Display the Page Layout panel in a modal loop. Saves any aquired 
+/** <p>Display the Page Layout panel in a modal loop. Saves any aquired 
    information in the shared NSPrintInfo object. Returns NSCancelButton 
-   if the user clicks the Cancel button or NSOKButton otherwise.
+   if the user clicks the Cancel button or NSOKButton otherwise.</p>
+   <p>See Also: -runModalWithPrintInfo:</p>
 */
 - (int)runModal
 {
   return [self runModalWithPrintInfo: [NSPrintInfo sharedPrintInfo]];
 }
 
-/** Display the Page Layout panel in a modal loop. Saves any aquired 
+/** <p>Displays the Page Layout panel in a modal loop. Saves any aquired 
    information in the indicated NSPrintInfo object. Returns NSCancelButton 
-   if the user clicks the Cancel button or NSOKButton otherwise.
+   if the user clicks the Cancel button or NSOKButton otherwise.</p>
+   <p>See Also: -runModal</p>
 */
 - (int)runModalWithPrintInfo:(NSPrintInfo *)printInfo
 {
@@ -302,14 +305,16 @@ enum {
 //
 // Customizing the Panel 
 //
-/** Returns the accessory view for the page layout panel 
+/**<p> Returns the accessory view for the page layout panel.</p>
+   <p>See Also: -setAccessoryView:</p>
  */
 - (NSView *)accessoryView
 {
   return [_controller accessoryView];
 }
 
-/** Set the accessory view for the page layout panel 
+/** <p>Sets the accessory view for the page layout panel</p>
+    <p>See Also: -accessoryView</p>
  */
 - (void)setAccessoryView:(NSView *)aView
 {
@@ -317,7 +322,6 @@ enum {
 }
 
 
-
 /** This method has been depreciated. It doesn't do anything useful.
 */
 - (void)convertOldFactor:(float *)old
@@ -373,15 +377,16 @@ enum {
   return [_controller printInfo];
 }
 
-/** Updates the receiver panel with information from its NSPrintInfo object
+/** <p>Updates the receiver panel with information from its NSPrintInfo object.
+    </p><p>See Also: -writePrintInfo</p>
  */
 - (void)readPrintInfo
 {
   [_controller readPrintInfo];
 }
 
-/** Writes any layout information set by the user to the receiver's
+/** <p>Writes any layout information set by the user to the receiver's
-    NSPrintInfo object
+    NSPrintInfo object</p><p>See Also: -readPrintInfo</p>
 */
 - (void)writePrintInfo
 {