• Open Menu Close Menu
  • Apple
  • Shopping Bag
  • Apple
  • Mac
  • iPad
  • iPhone
  • Watch
  • TV
  • Music
  • Support
  • Search apple.com
  • Shopping Bag

Lists

Open Menu Close Menu
  • Terms and Conditions
  • Lists hosted on this site
  • Email the Postmaster
  • Tips for posting to public mailing lists
Re: Documentation frustrations
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Documentation frustrations


  • Subject: Re: Documentation frustrations
  • From: Guy English <email@hidden>
  • Date: Sat, 9 Jul 2005 02:59:49 -0400

On 7/9/05, mmalcolm crawford <email@hidden> wrote:
> On Jul 8, 2005, at 11:14 PM, Guy English wrote:
>> [categories are a challenge to documentation]
> Indeed -- and this is an issue that has come up on several
> occasions.  Again feedback on how this might be better presented
> would be useful...

Well ... actually I went and looked at NSObject again and, indeed,
methods declared in categories *are* listed with the class. So I was
mistaken when I said that performSelector:withObject:afterDelay:
wasn't in there.

Honestly, it may be a little out of bounds as far as pure
documentation goes but the quickest fix I can think for this is to
have XCode handle a URL that'll open up an object in the class browser
( perferably with categories set to Always Merged Into Class set ).
Maybe make the class browser a little prettier too - group methods
based on the category they're defined in, add seperators and headers.
Maybe a bit like the Spotlight results window - nicely divided items
that you can expand to get a bit more info on. The documentation icon
in there is great - once some one has jumped from the docs, checked
out the class in the browser, they can easilly drill back into the
docs when they find a method that sounds helpful to them. I think if
you tie in the Class Browser you guys could stop pulling your hair out
trying to tie everything together - it'll get done at the code level.

Take care,
Guy
 _______________________________________________
Do not post admin requests to the list. They will be ignored.
Cocoa-dev mailing list      (email@hidden)
Help/Unsubscribe/Update your Subscription:

This email sent to email@hidden

References: 
 >Re: Documentation frustrations (From: Raffael Cavallaro <email@hidden>)
 >Re: Documentation frustrations (From: mmalcolm crawford <email@hidden>)
 >Re: Documentation frustrations (From: Raffael Cavallaro <email@hidden>)
 >Re: Documentation frustrations (From: mmalcolm crawford <email@hidden>)
 >Re: Documentation frustrations (From: Raffael Cavallaro <email@hidden>)
 >Re: Documentation frustrations (From: mmalcolm crawford <email@hidden>)
 >Re: Documentation frustrations (From: James Andrews <email@hidden>)
 >Re: Documentation frustrations (From: Guy English <email@hidden>)
 >Re: Documentation frustrations (From: mmalcolm crawford <email@hidden>)

  • Prev by Date: Re: Documentation frustrations
  • Next by Date: Re: Documentation frustrations
  • Previous by thread: Re: Documentation frustrations
  • Next by thread: Re: Documentation frustrations
  • Index(es):
    • Date
    • Thread