Documentatikon tweaks

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

ChangeLog

@@ -2,6 +2,14 @@
 
 	* Documentation/GNUmakefile.postamble: Tweak for make update.
 	* Source/DocMakefile: ditto
+	* Headers/gnustep/gui/NSLayoutManager.h: documentation tweaks.
+	* Headers/gnustep/gui/NSRulerMarker.h: ditto
+	* Headers/gnustep/gui/NSText.h: ditto
+	* Headers/gnustep/gui/NSTextContainer.h: ditto
+	* Source/NSLayoutManager.m: ditto
+	* Source/NSPopUpButtonCell.m: ditto
+	* Source/NSTextContainer.m: ditto
+	* Source/NSWorkspace.m: ditto
 
 2003-07-22  Andrew Ruder <aeruder@ksu.edu>
 

Headers/gnustep/gui/NSLayoutManager.h

@@ -76,8 +76,8 @@ typedef enum {
 - (BOOL) layoutManagerOwnsFirstResponderInWindow: (NSWindow *)window;
 
 -(NSArray *) rulerMarkersForTextView: (NSTextView *)textView
-		      paragraphStyle: (NSParagraphStyle *)style
+		      paragraphStyle: (NSParagraphStyle *)paragraphStyle
-			       ruler: (NSRulerView *)ruler;
+			       ruler: (NSRulerView *)aRulerView;
 -(NSView *) rulerAccessoryViewForTextView: (NSTextView *)textView
 			   paragraphStyle: (NSParagraphStyle *)style
 				    ruler: (NSRulerView *)ruler

Headers/gnustep/gui/NSRulerMarker.h

@@ -77,7 +77,7 @@
 
 - (void)drawRect:(NSRect)aRect;
 - (BOOL)isDragging; 
-- (BOOL)trackMouse:(NSEvent *)theEvent adding:(BOOL)flag; 
+- (BOOL)trackMouse:(NSEvent *)theEvent adding:(BOOL)adding; 
 
 @end
 

Headers/gnustep/gui/NSText.h

@@ -125,7 +125,7 @@ enum {
 		       withString: (NSString*)aString;
 /* PRIMITIVE */
 -(void) replaceCharactersInRange: (NSRange)aRange /* GNUstep extension */
-	    withAttributedString: (NSAttributedString *)aString;
+	    withAttributedString: (NSAttributedString *)attrString;
 /* PRIMITIVE */
 - (void) setString: (NSString*)aString;
 /* PRIMITIVE */

Headers/gnustep/gui/NSTextContainer.h

@@ -108,7 +108,7 @@ Initializes a new instance and sets the container size to aSize.
 
 
 /**
-<heading>Querying the region</heading>
+Querying the region
 */
 
 /**
@@ -176,7 +176,7 @@ Subclasses define regions by overriding this method.
 
 
 /**
-<heading>Managing the text network</heading>
+Managing the text network<br />
 
 A text container may be attached to one layout manager and one text view.
 The text container is retained by the layout manager, and retains the text
@@ -220,7 +220,7 @@ none.
 
 
 /**
-<heading>The container size</heading>
+The container size<br />
 
 A text container has a container size. The region defined by the text
 container must be a subset of the rectangle of this size with it's top-left
@@ -235,7 +235,7 @@ must be valid.
 
 
 /**
-<heading>Automatic resizing</heading>
+Automatic resizing<br />
 
 A text container can be set to automatically track the width and/or height
 of its NSTextView (TODO: frame? bounds?). For more information, see the
@@ -252,7 +252,7 @@ is resized.
 
 
 /**
-<heading>Line fragment padding</heading>
+Line fragment padding<br />
 
 The line fragment padding is an amount of space left empty at each end of
 a line fragment rectangle by the standard typesetter. The default is 0.0.

Source/NSLayoutManager.m

@@ -892,7 +892,7 @@ has the same y origin and height as the line frag rect it is in.
 -(unsigned int) characterIndexMoving: (GSInsertionPointMovementDirection)direction
 		  fromCharacterIndex: (unsigned int)from
 	      originalCharacterIndex: (unsigned int)original
-			    distance: (float)distance;
+			    distance: (float)distance
 {
   NSRect from_rect, new_rect;
   int from_tc, new_tc;

Source/NSPopUpButtonCell.m

@@ -314,7 +314,7 @@ static NSImage *_pbc_image[2];
     }
 }
 
-- (void)setImage:(NSImage *)anImage;
+- (void)setImage:(NSImage *)anImage
 {
   // Do nothing as the image is determined by the current item
 }

Source/NSTextContainer.m

@@ -318,33 +318,32 @@ framework intact.
   return _lineFragmentPadding;
 }
 
--(NSRect) lineFragmentRectForProposedRect: (NSRect)proposed
+- (NSRect) lineFragmentRectForProposedRect: (NSRect)proposedRect
-	sweepDirection: (NSLineSweepDirection)sweep
+			    sweepDirection: (NSLineSweepDirection)sweepDir
-	movementDirection: (NSLineMovementDirection)move
+			 movementDirection: (NSLineMovementDirection)moveDir
-	remainingRect: (NSRect *)remain
+			     remainingRect: (NSRect *)remainingRect
 {
   float minx, maxx, miny, maxy;
   float cminx, cmaxx, cminy, cmaxy;
 
-  minx = NSMinX(proposed);
+  minx = NSMinX(proposedRect);
-  maxx = NSMaxX(proposed);
+  maxx = NSMaxX(proposedRect);
-  miny = NSMinY(proposed);
+  miny = NSMinY(proposedRect);
-  maxy = NSMaxY(proposed);
+  maxy = NSMaxY(proposedRect);
 
   cminx = NSMinX(_containerRect);
   cmaxx = NSMaxX(_containerRect);
   cminy = NSMinY(_containerRect);
   cmaxy = NSMaxY(_containerRect);
 
-  *remain = NSZeroRect;
+  *remainingRect = NSZeroRect;
 
-  if (minx >= cminx && maxx <= cmaxx &&
+  if (minx >= cminx && maxx <= cmaxx && miny >= cminy && maxy <= cmaxy)
-      miny >= cminy && maxy <= cmaxy)
     {
-      return proposed;
+      return proposedRect;
     }
 
-  switch (move)
+  switch (moveDir)
     {
       case NSLineMoveLeft:
 	if (maxx < cminx)
@@ -390,7 +389,7 @@ framework intact.
 	break;
     }
 
-  switch (sweep)
+  switch (sweepDir)
     {
       case NSLineSweepLeft:
       case NSLineSweepRight:

Source/NSWorkspace.m

@@ -1130,7 +1130,7 @@ inFileViewerRootedAtPath: (NSString*)rootFullpath
  * to it using [NSConnection+rootProxyForConnectionWithRegisteredName:host:]
  * passing the application name (normally the filesystem name excluding path
  * and file extension) and an empty host name.  This will let you communicate
- * with the the [NSApplication-delagate] of the launched application, and you
+ * with the the [NSApplication-delegate] of the launched application, and you
  * can generally use this as a test of whether an application is running
  * correctly.
  * </p>