Re: Doxygen generated DocSets and Quick Help
Re: Doxygen generated DocSets and Quick Help
- Subject: Re: Doxygen generated DocSets and Quick Help
- From: "E. Wing" <email@hidden>
- Date: Sun, 4 Oct 2009 06:30:54 -0700
> 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);
>
Thanks for the response. If you mean by abstract line that I omit the
@brief tag, yes, I omit the @brief tag in my documentation. And I
never use the @internal tag.
I tried adding an explicit @brief, and sure enough, I start seeing
"Abstract: " followed by the brief description. (Too bad I have so
much code without this tag.)
I do not see anything in Quick Help related to my @param tags or
@return tags or anything else. Do you get any additional information
besides the brief description?
Thanks,
Eric
_______________________________________________
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