Отключить предупреждение "Комментарии к документации" для выбранных файлов

Question

Xcode имеет возможность проверять наличие проблем с комментариями к документации и сообщать о предупреждениях, когда что-то не так. Например, я добавил Facebook SDK в свой проект, используя CocoaPods. В какой-то момент в файле FBError.h есть следующий код:

/*!
 @typedef NS_ENUM (NSInteger, FBErrorCategory)

 @abstract Indicates the Facebook SDK classification for the error

 @discussion
 */

Обратите внимание, что @discussion параметр пуст, и Xcode сгенерирует предупреждение соответственно:

Пустой абзац передан команде '@discussion'

Тем не менее, Facebook SDK - не единственная библиотека, которую я добавил в свой проект, и вкладка "Проблемы" содержит множество других предупреждений, относящихся к документации из сторонних файлов, из установленных мной модулей.

Я хотел бы знать, как подавить такого рода предупреждение для этих файлов.

Answer 1

Вы можете использовать этот фрагмент для подавления предупреждений:

#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdocumentation"

#import <YourHeader.h>

#pragma clang diagnostic pop

см. этот выпуск cocoapod для деталей: https://github.com/CocoaPods/CocoaPods/issues/1481 (фрагмент оттуда)

Answer 2

Я сталкиваюсь с той же проблемой при использовании cocoapods.
Если вы используете cocoapods и хотите отключить предупреждения от файлов pods, вы можете сделать это:

1. В вашей цели Build Settings, Выбрать All && Levelsзатем найдите documentation comments,
2. Затем измените свой проект documentation comments в NOизмените цель documentation comments в YES,
3. Затем очистите сборку флопа (нажмите Ctrl +Option+Shift+K), перестроите свою цель. Вы заставите замолчать Document issue предупреждение из ваших файлов стручков, и все же есть их для ваших собственных файлов.
4. Если вы хотите замолчать и свои собственные файлы, сохраните вашу цель documentation comments в NO сделает свое дело.
5. Результат будет выглядеть так:

Answer 3

Как насчет игнорирования предупреждения, поступающего из библиотеки, добавленной cocoapods?

В своем подфайле добавьте

inhibit_all_warnings!

убрать все предупреждения

Или же

pod 'Facebook-iOS-SDK', :inhibit_warnings => true

удалить предупреждения из конкретной библиотеки.