xcode - Deshabilitar la advertencia de "Comentarios de documentación" para los archivos seleccionados

documentation warnings

Question

Xcode tiene la capacidad de verificar problemas de Comentarios de documentación e informar advertencias cuando algo no está bien. Por ejemplo, he agregado el SDK de Facebook a mi proyecto usando CocoaPods. En algún punto del archivo FBError.h está el siguiente código:

/*!
@typedef NS_ENUM (NSInteger, FBErrorCategory)
@abstract Indicates the Facebook SDK classification for the error
@discussion
*/

Tenga en cuenta que el parámetro @discussion está vacío, y Xcode generará una advertencia en consecuencia:

Párrafo vacío pasado al comando ''@discussion''

Sin embargo, el SDK de Facebook no es la única biblioteca que he agregado a mi proyecto, y la pestaña Problemas está llena de otras advertencias relacionadas con la documentación de archivos de terceros, desde los Pods que instalé.

Me gustaría saber cómo suprimir este tipo de advertencia para esos archivos.

Answer 1

¿Qué hay de ignorar la advertencia proveniente de la biblioteca agregada por los cocoápodos?

En su podfile, agregue

inhibit_all_warnings!

para eliminar todas las advertencias

O

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

para eliminar las advertencias de la biblioteca específica.

Answer 2

Me enfrento al mismo problema cuando uso cocoapods.
Si está utilizando cocoapods y desea silenciar las advertencias de los archivos de pods, puede hacer esto:

1. En la Build Settings su objetivo, seleccione All Levels &&, luego busque los documentation comments .
2. Luego, cambie los documentation comments la documentation comments su Proyecto a NO , cambie los documentation comments la documentation comments su objetivo a YES .
3. Luego, limpie el codificador de compilación (presione Comando + Opción + Mayús + K), vuelva a crear su objetivo. Silencie la advertencia de Document issue de sus archivos de pods y aún los tendrá para sus propios archivos.
4. En caso de que también desee silenciar sus propios archivos, mantenga los trucos de la documentation comments su objetivo en NO .
5. El resultado se verá así:

Answer 3

Puede utilizar este fragmento para suprimir las advertencias:

#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdocumentation"
#import <YourHeader.h>
#pragma clang diagnostic pop

Consulte este tema sobre cocoapod para obtener más información: https://github.com/CocoaPods/CocoaPods/issues/1481 (el fragmento viene de allí)