DocoaBrowser Homepage

What is DocoaBrowser?

DocoaBrowser lets you browse and search Apple's Cocoa frameworks documentation as well as your own source code documentation in AutoDoc format. It can instruct its companion application AutoGraf to generate different kinds of diagrams for Apple's frameworks or your own Objective-C projects.

DocoaBrowser is a free application, with its source code available under the GPL.

Downloads

Key Features

DocoaBrowser provides you with a hierarchical overview of available class and method documentation. Initially, this will be the documentation for Apple's Foundation, AppKit and WebKit frameworks, generated from the HTML shipped with the Developer Tools. You can add your own project's documentation by clicking the button labeled with a '+'-sign at the bottom left of the main window.

Use the search field in the toolbar of the main window to quickly jump to the documentation for a certain item. Just enter the first few letters of the item's name. DocoaBrowser will try to auto-complete the entered string. To see a list of all matching item titles, press the down arrow key on your keyboard. Select an item using the return key. Use the checkboxes next to the documentation sources names to select the sources that should be searched when using the search field.

To generate diagrams using AutoGraf, DocoaBrowser's companion application select the documentation source and click the "AutoGraf" button. AutoGraf is then opened and generates a diagram for the classes contained in the selection. For more information about AutoGraf's features see the AutoGraf's online help. Note that clicking on a classes or methods name in AutoGraf instructs DocoaBrowser to browse to the documentation for the clicked item.

DocoaBrowser History

DocoaBrowser is inspired by Cocoa Browser written by Hoshi Takanori and others. Until version 0.4, DocoaBrowser was built on top of the Cocoa Browsers code base. Starting with version 1.0 DocoaBrowser has been completly rewritten from scratch to provide better integration with its companion application AutoGraf and the AutoDoc utility.

Detailed Version History

• Completely rewritten from scratch
• on first run builds index from Apple's HTML documentation using apple_ref anchors
• integrates with AutoGraf
• includes AutoDoc as framework for better performance when scanning custom documentation
• can search several documentation sources at once

• can display developer documentation shipped with Xcode Preview 1.2
• fix navigation HTML documentation bug

• printing works
• links starting with "." are now displayed in DocoaBrowser (previously Safari would be launched for such URLs)
• toolbar customization works
• on-page search works
• added "Bigger" and "Smaller" buttons the toolbar
• added service menu to search from other applications
• added "Update" button to Preferences Dialog that updates your custom AutoDoc documentation

• uses WebKit instead of NSTextView for displaying documentation, thus fixing some odd problems with selecting text in tables and improper drawing when using zooming
• added topic search field that lets you jump to method and class documentation with just a few keystrokes.
• you can view your own AutoDoc documentation (both HTML and source). Adds paths to your files using the Preferences panel
• highlights methods with missing AutoDoc documentation (a.k.a. lazy coders nightmare)

Working AutoDoc Documentation

AutoDoc is a utility for generating source code documentation from comments within the Objective-C source code. For more information about the AutoDoc comment syntax download the latest AutoDoc source code package from ftp://ftp.misckit.com/pub/next/misckit/AutoDoc-2.0CurrentBeta.s.tar.gz and see the enclosed AutoDoc Guide.

Source Code Availability

Docoa Browser's source code is available under the terms of the GNU General Public License (GPL) from this address:http://sourceforge.net/projects/docoabrowser/. See the file 'copying' included with the source code for the terms of GPL.

Acknowledgments

Carl E. Lindberg and Don Yacktman for the AutoDoc utility and the MiscKit. See http://www.misckit.com/ for more information about the MiscKit and AutoDoc.

Hoshi Takanori and others for the original CocoaBrowser version.

System Requirements

• Mac OS X 10.3.3
• Xcode version 1.2

Contact Information