Re: [Ping/RFA]: ObjC Documentation

["Eli Zaretskii" <eliz@elta.co.il>]

> Date: Sat, 31 May 2003 21:52:41 -0600
> From: Adam Fedor <fedor@doc.com>
> 
> This patch hasn't been reviewed yet:
> 
> http://sources.redhat.com/ml/gdb-patches/2003-04/msg00542.htm

Sorry, my bad; I missed the original message somehow.

Here are my comments:

    +@itemx .m
    +Objective-C source file

This should be "@item .m", not @itemx.  @itemx is only used when you
have several table items which all share the same text, like this:

    @item foo
    @itemx bar
    @itemx baz
    Sample items for the same descriptive text.

    +The following commands have been extended to accept Objective-C method
    +names as line specifications:
    +
    +@itemize
    +@item @code{clear}
    +@item @code{break}
    +@item @code{info line}
    +@item @code{jump}
    +@item @code{list}
    +@end itemize

These need index entries for the special syntax of these commands
when debugging Objective-C programs.  Like this:

     @kindex clear@r{, and Objective-C}

Also, the general form of the extended commands is something I sorely
miss in this description.  Given the example:

    +@example
    +break -[Fruit create]
    +@end example

someone like me who doesn't speak fluent Objective-C is left wondering
what is "Fruit" and why do I need the `-' and the brackets.  Yes, I
know, some of that is explained further down, but a general form of
each command early on would both make the esamples more clear and
serve as an instant reminder for someone who just needs to see the
general rule.

Finally, please imagine that you are a user looking up the manual for
some specific issues pertinent to these features, and add index
entries for any issues users might wish to use to find the text you
wrote.

With those comments taken care of, the patch is approved.  Feel free
to ask if something in what I wrote is unclear.

Last, but not least: thanks for working on this!