RFA/doc: couple of small Obj-C documentation tweaks

Jason Molenda
2004-01-07T01:34:41Z

[-- Attachment #1: Type: text/plain, Size: 364 bytes --]

Hi Eli & Adam,

I was looking at the gdb docs today and saw a couple of small problems
with the Objective-C section. OK to commit?

2004-01-06 Jason Molenda (jmolenda@apple.com)

* doc/gdb.texinfo (Objective-C): "methodName" typeo.
Add @code markup around var names from examples.
Minor cleanup to _NSPrintForDebugger explanation.

[-- Attachment #2: pa.txt --]
[-- Type: text/plain, Size: 1765 bytes --]

2004-01-06 Jason Molenda (jmolenda@apple.com)

* doc/gdb.texinfo (Objective-C): "methodName" typeo.
Add @code markup around var names from examples.
Minor cleanup to _NSPrintForDebugger explanation.

Index: gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.185
diff -u -p -r1.185 gdb.texinfo
--- gdb.texinfo 28 Oct 2003 22:04:47 -0000 1.185
+++ gdb.texinfo 7 Jan 2004 01:01:33 -0000
@@ -8484,7 +8484,7 @@ A fully qualified Objective-C method nam

where the minus sign is used to indicate an instance method and a plus
sign (not shown) is used to indicate a class method. The
-class name @var{Class} and method name @var{methoName} are enclosed in
+class name @var{Class} and method name @var{methodName} are enclosed in
brackets, similar to the way messages are specified in Objective-C source
code. For example, to set a breakpoint at the @code{create} instance method of
class @code{Fruit} in the program currently being debugged, enter:
@@ -8532,12 +8532,12 @@ print -[object hash]
@end smallexample

@cindex print an Objective-C object description
-will tell gdb to send the -hash message to object and print the
+will tell gdb to send the @code{hash} message to @code{object} and print the
result. Also an additional command has been added, @code{print-object}
or @code{po} for short, which is meant to print the description of an
object. However, this command may only work with certain Objective-C
-libraries that have a particular hook function, called
-@code{_NSPrintForDebugger} defined.
+libraries that have a particular hook function,
+@code{_NSPrintForDebugger}, defined.