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

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

/*!
 @typedef NS_ENUM (NSInteger, FBErrorCategory)

 @abstract Indicates the Facebook SDK classification for the error

 @discussion
 */

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

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

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

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

ОТВЕТЫ

Ответ 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 (отрывок из этого фрагмента)

Ответ 2

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

В вашем podfile добавьте

inhibit_all_warnings!

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

или

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

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

Ответ 3

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

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

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