Désactiver “les Commentaires de la Documentation” avertissement pour les fichiers sélectionnés

Xcode a la capacité de vérifier les Commentaires de Documentation et d'avertissements lorsque quelque chose n'est pas tout à fait droit. Par exemple, j'ai ajouté Facebook SDK pour mon projet à l'aide de CocoaPods. À un certain point dans le fichier FBError.h il y a le code suivant:

/*!
 @typedef NS_ENUM (NSInteger, FBErrorCategory)

 @abstract Indicates the Facebook SDK classification for the error

 @discussion
 */

Noter que le @discussion paramètre est vide, et Xcode va générer un message d'avertissement en conséquence:

Paragraphe vide passés à '@discussion " commande

Cependant, Facebook SDK n'est pas la seule bibliothèque j'ai ajouté à mon projet, et les Questions onglet est plein d'autre documentation concernant les mises en garde de la 3ème partie des fichiers, de les Gousses que j'ai installé.

Je voudrais savoir comment faire pour supprimer ce genre de mise en garde pour ces fichiers.

  • Selon la configuration de votre projet d'installation et Projet(s), Cible(s), et les Dépendances ont des Commentaires de Documentation (CLANG_WARN_DOCUMENTATION_COMMENTS) défini à Oui, permettra de déterminer les pistes sont ouvertes pour la suppression de choses. Pourriez-vous poster une version aseptisée de votre podspec et de la liste au niveau du projet et/ou de la cible au niveau de(s) où vous avez mis "les Commentaires de la Documentation" à OUI?
  • Essayez cela avec XCode 8 https://stackoverflow.com/questions/42991455/silencing-documentation-issue-warnings-in-xcode/43234526#43234526
InformationsquelleAutor Guilherme | 2014-06-27
  1. 33

    Vous pouvez utiliser cet extrait de code pour supprimer les avertissements:

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

#import <YourHeader.h>

#pragma clang diagnostic pop

    voir ce cocoapod-question pour plus de détails: https://github.com/CocoaPods/CocoaPods/issues/1481 (extrait vient de là)

    • Merci! Ce n'est pas grand d'avoir à faire là où les en-têtes sont importés, mais c'est mieux que de désactiver les mises en garde pour l'ensemble de la cible.
    • c'est moins de frappe si vous créez une macro pour le pragma paramètres, à savoir: #define DISABLE_DWARN \ _Pragma("bruit de diagnostic push") \ _Pragma("bruit de diagnostic d'alerte \"-Wdeprecated-déclarations\"") mais je ne pense pas que vous pouvez utiliser #import dans une macro.
    • Je reçois un avertissement, sauf si la dernière ligne est #pragma clang diagnostic pop
    • C'est fantastique. J'ai travaillé avec l'aws-sdk-rpc bibliothèque dans Xcode, et il génère des centaines de "la Documentation de l'Émission" mises en garde. Ces pragmas de résoudre ce problème.
    InformationsquelleAutor Thorsten
  2. 12

    Je suis face au même problème lors de l'utilisation de cocoapods.

    Si vous utilisez cocoapods, et veut faire taire les avertissements à partir de gousses de fichiers,vous pouvez le faire:

    1. Dans votre cible Build Settings, sélectionnez All && Levels, puis de rechercher les documentation comments.
    2. Puis changement de votre Projet documentation comments à NO,changement de votre cible documentation comments à YES.
    3. Puis Nettoyer construire floder(Appuyez sur Commande+Option+Maj+K), rebuid votre cible.Vous aurez le silence de la Document issue avertissement de la part de vos gousses de fichiers, et ont encore pour vos propres fichiers.
    4. Dans le cas où vous souhaitez le silence de vos propres fichiers, garder votre cible documentation comments à NO fera l'affaire.
    5. Le résultat ressemblera à ceci:

    Désactiver “les Commentaires de la Documentation” avertissement pour les fichiers sélectionnés

    • la documentation des avertissements apparaissent toujours après suivant les étapes dans votre question, même après le nettoyage reconstruit
    • vérifier à la fois la cible et le projet Documentation Comments, sélectionnez "Niveaux" dans le coin supérieur gauche, pour voir ce que le Resolved résultat est, et à quoi le remplacer .
    • J'ai dû tourner les commentaires de la documentation off lors de la sélection de mes Gousses de sous-projet pour obtenir les mises en garde à disparaître.
    InformationsquelleAutor wj2061
  3. 8

    Qu'en ignorant l'avertissement à venir à partir de la bibliothèque ajouté par cocoapods?

    Dans votre podfile, ajouter

    inhibit_all_warnings!

    pour supprimer tous les avertissements

    Ou

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

    pour supprimer les avertissements de bibliothèque spécifique.

    • Cela ne fonctionne pas pour la documentation
    • Je vous remercie. Cela fonctionne pour moi.# Uncomment the next line to define a global platform for your project platform :ios, '10.3' inhibit_all_warnings! pod 'RealmSwift'
    InformationsquelleAutor Y.Bonafons