Re: Doxygen generated DocSets and Quick Help
Re: Doxygen generated DocSets and Quick Help
- Subject: Re: Doxygen generated DocSets and Quick Help
- From: "Adam R. Maxwell" <email@hidden>
- Date: Fri, 02 Oct 2009 21:57:26 -0700
On Oct 2, 2009, at 12:23 PM, E. Wing wrote:
On 10/2/09, Brent Shank <email@hidden> wrote:
Does Quick Help find documentation for any of your symbols?
Quick Help will find Apple symbols. I just haven't had any luck with
it finding ones from my generated DocSet.
Do you use @brief with any of yours, or include an abstract line? I
notice that Quick Help won't find functions or methods documented like
this:
/** @internal
Creates an NSGraphicsContext using an NSWindow as backing. Intended
for use in +initialize when +[NSGraphicsContext currentContext] may be
nil.
@param size Size of the window to create.
@return A new, autoreleased instance of NSGraphicsContext. */
FV_PRIVATE_EXTERN NSGraphicsContext *FVWindowGraphicsContextWithSize
(NSSize size);
but it shows "For use with integer-valued dictionaries" for the
following function:
/** @internal @brief For use with integer-valued dictionaries.
@param dict CFDictionary with integer values.
@param key Key of interest.
@param value Pointer in which to return the value.
@return TRUE if the key was present, FALSE if not present */
FV_PRIVATE_EXTERN Boolean FVCFDictionaryGetIntegerIfPresent
(CFDictionaryRef dict, const void *key, NSInteger *value);
Obj-C documentation seems to behave similarly, although in no cases
does Quick Help show the class name; all I see is the method name and
abstract. This is with Doxygen 1.6 on 10.6.1.
Attachment:
smime.p7s
Description: S/MIME cryptographic signature
_______________________________________________
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