Re: .dox file
Re: .dox file
- Subject: Re: .dox file
- From: Fritz Anderson <email@hidden>
- Date: Thu, 19 Dec 2013 12:45:16 -0600
On 19 Dec 2013, at 12:26 PM, Jens Alfke <email@hidden> wrote:
> Xcode 5 supports Doxygen syntax as well as HeaderDoc. It shows doc-comments in the autocomplete pop-up and when you option-click a symbol.
>
/** The human-readable description of a quiz, given its human-readable name. The name is a key into `QuizSpecifications.plist`, which should assign a `quiz description` key to each known quiz.
@param humanReadableName the name of a quiz, as presented to the user.
@return the description of the named quiz.
@return `nil` if the named quiz does not exist.
@throw NSInternalInconsistencyException (`NSAssert`) if the `quiz description` key is not defined for the named quiz.
*/
@throw is accepted in Doxygen 1.8.7, not recognized in Xcode 5.0.2. Nor is Markdown markup, though that's understandable.
> And there’s even a Clang compiler flag that will issue warnings about improper Doxygen syntax, like documenting a function/method parameter that doesn’t exist.
The last paragraph in the message you were… refining was "There's a build setting that will lint documentation comments."
I stand sort-of corrected on the .dox internal-configuration file, but it's a zebra in a code-distribution package.
— F
_______________________________________________
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