Documentation Wish - was Re: AppKit source available as reference?
Documentation Wish - was Re: AppKit source available as reference?
- Subject: Documentation Wish - was Re: AppKit source available as reference?
- From: Scott Anguish <email@hidden>
- Date: Sun, 1 Jul 2001 16:47:50 -0400
On Sunday, July 1, 2001, at 11:01 AM, Candide Kemmler wrote:
Le samedi 30 juin 2001, ` 11:54, Erik M. Buck a icrit :
Would anyone care to identify "good" documentation ? Would anyone
care to
identify a more consistent or clearer framework ?
good documentation is cross-referenced, and makes use of hyperlinks:
when a function returns an object that's also documented, a link is
provided to jump to that object's documentation. ditho for the
parameters,...
I suggest that you don't need to go back to a framework's list of
classes everytime you want to consult another class' documentation.
Frames are a good option for this (why not get inspiration from
javadoc's format ?).
Oh please no. JavaDoc just sucks. and I'd much rather have a
method of getting at my documentation without reverting to the lowest
common denominator of using a web browser
What I'd really like to see is Apple encode all their documentation
using XML. That way it would be easily parsed into other formats.
Ideally what I want is something that has the ability to jump to
different parts based on what you click on, and only show portions that
are relevant (i.e, not load the entire document and scroll to a
location).
often I don't want to read the documentation, but just want to get
the params that I need to pass (or review spelling). All of this would
be much easier with a documentation tool accessing the docs in XML.