Re: Documentation Wish - was Re: AppKit source available as reference?
Re: Documentation Wish - was Re: AppKit source available as reference?
- Subject: Re: Documentation Wish - was Re: AppKit source available as reference?
- From: Jonathan Hendry <email@hidden>
- Date: Sun, 1 Jul 2001 23:58:02 -0500
On Sunday, July 1, 2001, at 06:32 , Michael Dagate wrote:
Granted that Help Viewer.app sucks hard ;), HTML is not
necessarily bad for documentation. It works for the zillions of
web pages on the Internet and it hyperlinks well. The problem
seems to be one of content (too little) and implementation (too
much info on one page). Smaller pages, more links and a separate
frame with a Table of Contents would speed navigation tremendously.
I'd rather have pages that are too big than pages that are too little.
HelpViewer isn't designed for large documents. You can only find
documents, you can't find within the document, which hamstrings
it for use with class docs.
I'd like to see HeaderViewer come back. It used precompiled headers
to provide a browsable hierarchy of classes, including methods
and other symbols defined in a class. If I recall correctly, clicking
a method or symbol name would take you to its declaration in the header.
Crafty use of HTML or XHTML should make it possible to jump to a
method's or symbol's documentation automatically, if there were another
HeaderViewer app.