Getting Doxygen comments into Quick Help
Getting Doxygen comments into Quick Help
- Subject: Getting Doxygen comments into Quick Help
- From: Fritz Anderson <email@hidden>
- Date: Fri, 15 Jan 2010 13:13:34 -0600
This had been covered on this list before, but the "solution" provided in that thread doesn't work for me.
I have commented some methods in one of my classes (see the fragment at the end of this message). I use the @brief tag, which the previous thread suggested was all that was needed to get the method into the Quick Help (and Documentation window API search?) system. Using the GUI, I pointed Doxygen at the directory containing my class declaration, and made sure GENERATE_DOCSET, DOCSET_FEEDNAME, and DOCSET_BUNDLE_ID were set.
(It turns out @brief is necessary to render as-expected; @discussion is not. I wish the syntax coloring would recognize Doxygen markup.)
I generated the documentation; no errors were reported, and opening the HTML shows what I'd expect. I went to the generated html/ directory and ran "make install". I quit and reopened Xcode. My docset shows up in the "m of n Doc Sets" drop-down. Searching for, for instance, "addM" produces a full-text hit on my addMarker: documentation — but NOT an API hit. My documentation renders as expected in the Documentation window, except for the lack of API indexing.
Option-double-clicking on a call to addMarker: produces a Quick Help window that says there is not documentation for that symbol.
What should I do to get my API into Quick Help via Doxygen?
— F
/*! @brief Inform the Google API whether the application has a location sensor.
@discussion Google requires you to state whether the application
fetching the map has access to its own geographic location.
This would be YES for iPhone and iPod Touch devices, and, I think,
for some Macs that have Location Services.
@param uses BOOL, whether the application has location services.
*/
+ (void) setUsesSensor: (BOOL) uses;
/*! @brief Add a marker to be shown in the generated map.
The supplied GoogleMarker is appended to the list of markers
that will be requested in the final URL.
@param aMarker A marker to append to the list. Must not be nil.
*/
- (void) addMarker: (GoogleMarker *) aMarker;
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Xcode-users mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden