Re: Documentation window
Re: Documentation window
- Subject: Re: Documentation window
- From: Matt Morse <email@hidden>
- Date: Tue, 6 Jan 2004 11:11:10 -0800
MiMo--
The features you request are definitely on the list--there have been
many similar requests.
I'm forwarding a response to a similar question posted earlier. It
outlines a way to make your documentation searchable (through the
API-Search feature) now in the doc window.
-- Matt
Begin forwarded message:
> From: Matt Morse <email@hidden>
> Date: January 3, 2004 10:36:26 AM PST
> To: Michael Taubert <email@hidden>
> Cc: email@hidden
> Subject: 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 6, 2004, at 5:57 AM, Michael Monscheuer wrote:
> Is there a possibility to add the somehow created documentation of my
> project to XCode documentation window?
>
> I think project documentation features should be integrated into XCode
> in the future. I'm hardly missing it. OK, OK - there is AutoDoc and
> HeaderDoc but there still there seems a lack of integration. If
> projects rise to a big umbrella framework it would be nice to have
> direct access to project documentation and its creation as part of
> XCode.
>
> MiMo
> --
> =======================================================
> And refashioning the fashioned
> lest it stiffen into iron
> is work of endless vital activity.
> [Goethe]
>
> mailto:email@hidden
> mailto:email@hidden
>
> All about CALAMUS DTP suite:
> http://www.calamus.net
>
> =======================================================
> _______________________________________________
> 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.