This is the mail archive of the gdb-patches@sources.redhat.com mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [Ping/RFA]: ObjC Documentation


> Date: Fri, 06 Jun 2003 19:49:55 -0600
> From: Adam Fedor <fedor@doc.com>
> 
> Thanks for the comments. Here's the final patch...

Approved, but please make these minor corrections:

> +@cindex Objective-C
> +@value{GDBN} can be used to debug programs written in Objective-C,
> +using either the Apple/NeXT or the GNU Objective-C runtime.

The index entry "@cindex Objective-C" should not be here, but where
the features specific to Objective-C are described:

> +@node Objective-C
> +@subsection Objective-C

here.

> +A fully qualified Objective-C method name is specified as
> +
> +@example
> +-[Class methodName]
> +@end example

Please change this to the following:

 +@example
 +-[@var{Class} @var{methodName}]
 +@end example

"Class" and "methodName" are meta-syntactic variables (they stand for
something else), and you use them, correctly, inside @var{} in the
text that explains this notation.  So they should be in @var{} here as
well.

With these two changes, please commit the patch.  Thanks!


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]