Re: suggestions for documentation integration
Re: suggestions for documentation integration
- Subject: Re: suggestions for documentation integration
- From: Dave Camp <email@hidden>
- Date: Thu, 8 Nov 2007 15:23:58 -0800
On Nov 8, 2007, at 2:45 PM, Ronald Hayden wrote:
What
I was expecting by now is that every method listing would have a
little
"paste" button next to it (or even some less clicky device) that
would
transfer the template for this method right to the selection point
in the
frontmost code window.
This is an existing request, which we didn't spend time on for
Leopard because we felt that the code sense functionality was better
optimized for this sort of thing than anything we could probably
provide in the documentation, and so it was better for us to focus
on other aspects of the major doc viewing overhaul we did for Leopard.
Also, we get requests to add various doohickeys to the doc, such as
buttons to jump from each section to the top of the document, and
I'm way of adding a bunch of UI to documentation. For me, it tends
to be distracting, and just something I might accidentally click
while scrolling around.
That said, especially since this has been requested multiple times,
we're certainly open to considering it.
Oh! A "paste/insert/do something smart" like thing would be very nice.
I use code sense a lot, but it's only really useful when you've got
some idea of what it is you want. To further Matt's idea, I've got the
NSString page open and I'm trying to find the thing that appends paths
to a string, or make a new string with a path appended or whatever. I
can never remember it. I'm now focused on the docs, I'm scrolling the
docs pane either with the keyboard or the scrollwheel and I find the
method I want: stringByAppendingPathComponent:
The insertion point is in the correct spot in my code, and the thing I
want is right there in the docs window. My choices are either go back
to the source, bring up code sense, start typing (without misspelling)
and press Tab when I get the right method, or double-click the method
in the docs, copy, paste, and then click after each colon to manually
insert my arguments. The first way takes longer and I botch the
spelling a lot. The second way is faster but I often click on the left
side of the colon or something. The click target area is quite small
in this case (between a colon and a letter) and a longer method can
take 4 or more clicks. As monitor DPI goes up this becomes more
challenging.
Both of those are error prone and take too many clicks.
If there was some way to click a button in the docs that would trigger
code sense in the last source code window to insert the code sense
version of the method call complete with the argument placeholders,
that seems like it would be a win. After that single mouse click I'm
completely back at the keyboard again using Control-/ to go to each
argument and type in or code sense each parameter to be inserted.
Dave
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Xcode-users mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden