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: Sun, 04 Oct 2009 08:59:48 -0700
On Oct 4, 2009, at 6:30 AM, E. Wing wrote:
Do you use @brief with any of yours, or include an abstract line?
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.
This is from a framework of mine, so it's littered with @internal.
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.)
If you do this
/** This is an abstract line.
This is the remainder of the documentation. */
void somefunction();
you should see "This is an abstract line" show up in Quick Help.
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?
No, all I get is the method/function name in the panel title and the
abstract line as the content. Since my abstract line generally just
restates the method/function with punctuation, it's not that helpful :).
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