• Open Menu Close Menu
  • Apple
  • Shopping Bag
  • Apple
  • Mac
  • iPad
  • iPhone
  • Watch
  • TV
  • Music
  • Support
  • Search apple.com
  • Shopping Bag

Lists

Open Menu Close Menu
  • Terms and Conditions
  • Lists hosted on this site
  • Email the Postmaster
  • Tips for posting to public mailing lists
Re: How to silence documentation warnings?
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: How to silence documentation warnings?


  • Subject: Re: How to silence documentation warnings?
  • From: Mike Crawford <email@hidden>
  • Date: Thu, 29 Jun 2017 15:08:57 -0700

> I’ve never seen that. I’m familiar with that warning, but it only happens
> when the tags in the doc-comments don’t match the actual function signature,
> and Apple’s comments don’t have problems like that.
>
> What do the warnings look like exactly?

Empty paragraph passed to '@return' command

Empty paragraph passed to '@discussion' comment

'@function' command should be used in a comment attached to a function
declaration

'@param' command used in a comment that is not attached to a function
declaration

I'm writing a driver so maybe these problems are only found in the
kernel headers.

I'll look at the build settings now.

Mike
 _______________________________________________
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

References: 
 >How to silence documentation warnings? (From: Mike Crawford <email@hidden>)
 >Re: How to silence documentation warnings? (From: Jens Alfke <email@hidden>)

  • Prev by Date: Re: How to silence documentation warnings?
  • Next by Date: Re: How to silence documentation warnings?
  • Previous by thread: Re: How to silence documentation warnings?
  • Next by thread: Re: How to silence documentation warnings?
  • Index(es):
    • Date
    • Thread