Mailing Lists: Apple Mailing Lists

Image of Mac OS face in stamp
 
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: API-search path



Michael,

Currently, there's no easy way to get your own doc searched by the API Search feature of Xcode's documentation window. We definitely want to add that ability in a future release, though.

That said, you can add your reference doc to the set that Xcode searches by this manual process:

1. Your documentation has to have the necessary "apple_ref" HTML anchors in it for Xcode's indexer to index it. If the doc is generated by HeaderDoc, those anchors are present. If not, see /Developer/Documentation/DeveloperTools/HeaderDoc/APIAnchors.html for a description of the anchors and add them to your HTML reference.

2. Xcode's indexer only searches specific areas of the file system for documentation to index. The file that lists these areas is "/Developer/Documentation/Help/Developer Help Viewer/MacOSXDeveloper.pbHelpIndexerList". Either make sure your documentation is within one of the listed folders, or add a new path to the list.

3. Run the indexer to reindex the documentation.  In a Terminal window:

> sudo /Developer/Tools/pbhelpindexer

Hope this helps,
-- Matt


On Jan 3, 2004, at 6:32 AM, Michael Taubert wrote:

Hi all,

how do I add additional paths for the API-search feature? It would be nice to have this feature using
my own Documentation too.


Thanks,
Michael
_______________________________________________
xcode-users mailing list | email@hidden
Help/Unsubscribe/Archives: http://www.lists.apple.com/mailman/listinfo/xcode-users
Do not post admin requests to the list. They will be ignored.
_______________________________________________
xcode-users mailing list | email@hidden
Help/Unsubscribe/Archives: http://www.lists.apple.com/mailman/listinfo/xcode-users
Do not post admin requests to the list. They will be ignored.

References: 
 >API-search path (From: Michael Taubert <email@hidden>)



Visit the Apple Store online or at retail locations.
1-800-MY-APPLE

Contact Apple | Terms of Use | Privacy Policy

Copyright © 2007 Apple Inc. All rights reserved.