Deaktivieren Sie die "Documentation Comments" Warnung für ausgewählte Dateien

Xcode ist die Möglichkeit zu prüfen, für die Dokumentation Fragen und Kommentare Bericht Warnungen, wenn etwas nicht ganz richtig ist. Zum Beispiel, die ich Hinzugefügt habe, Facebook SDK, um mein Projekt mit CocoaPods. An einem gewissen Punkt in der Datei FBError.h gibt es den folgenden code:

/*!
 @typedef NS_ENUM (NSInteger, FBErrorCategory)

 @abstract Indicates the Facebook SDK classification for the error

 @discussion
 */

Beachten Sie, dass die @discussion parameter leer ist, und Xcode wird eine Warnung generieren, entsprechend:

Leeren Absatz übergeben '@Diskussion' Befehl

Jedoch, Facebook SDK ist nicht die einzige Bibliothek, die ich Hinzugefügt habe zu meinem Projekt und den Fragen der tab ist voll von anderen Dokumentationen Warnungen von 3rd-party-Dateien, die von den Hülsen habe ich installiert.

Ich würde gerne wissen, wie zu unterdrücken, diese Art von Warnung für diejenigen, die Dateien.

  • Je nachdem, wie Sie Ihr Projekt einrichten und die Projekt(s), Target(s), und Abhängigkeiten müssen in der Dokumentation Kommentare (CLANG_WARN_DOCUMENTATION_COMMENTS) auf ja gesetzt wird bestimmen, welche Wege sind offen für die Unterdrückung der Dinge. Könnte Sie veröffentlichen eine bereinigte version Ihres podspec und die Liste der Projekt-Ebene und/oder der Ziel-Stufe(N), wo Sie sich gesetzt haben, Dokumentations-Kommentare, JA?
  • Versuchen Sie, diese mit XCode 8 https://stackoverflow.com/questions/42991455/silencing-documentation-issue-warnings-in-xcode/43234526#43234526
InformationsquelleAutor Guilherme | 2014-06-27
  1. 33

    Können Sie dieses snippet um die Warnungen zu unterdrücken:

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

#import <YourHeader.h>

#pragma clang diagnostic pop

    sehen diese cocoapod-Ausgabe details: https://github.com/CocoaPods/CocoaPods/issues/1481 (snippet kommt von dort)

    • Danke! Es ist nicht toll, dies zu tun, wo die Header importiert werden, aber es ist besser als das deaktivieren der Warnungen für die gesamte Zielgruppe.
    • es ist weniger eingeben, wenn Sie ein makro erstellen, für die pragma-Einstellungen, also: #define DISABLE_DWARN \ _Pragma("clang diagnostic push") \ _Pragma("clang diagnostic warning \"-Wdeprecated-declarations\"") aber ich glaube nicht, können Sie #import in ein makro.
    • Ich bekomme eine Warnung, es sei denn, die Letzte Zeile ist #pragma clang diagnostic pop
    • Das ist fantastisch. Ich ' ve wurden arbeiten mit der aws-sdk-cpp library in Xcode, und er erzeugt Hunderte von "Documentation Problem" Warnungen. Diese pragmas lösen, dass problem.
    InformationsquelleAutor Thorsten
  2. 12

    Ich vor den gleichen Problem bei der Verwendung von cocoapods.

    Wenn Sie mit cocoapods, und will die Stille die Warnungen von Hülsen-Dateien,können Sie dies tun:

    1. In Ihrem Ziel Build Settings wählen Sie All && Levels ist, dann suchen Sie für documentation comments.
    2. Ändern Sie dann Ihr Projekt documentation comments zu NOändern Sie Ihre Ziel - documentation comments zu YES.
    3. Dann Sauber aufbauen floder(Drücken Sie Befehlstaste+Option+Shift+K), rebuid Ihr Ziel.Sie wird schweigen der Document issue Warnung Ihres pods-Dateien, und noch haben Sie für Ihre eigenen Dateien.
    4. In Fall, dass Sie wollen, zum schweigen zu bringen Ihre eigenen Dateien als auch, halten Sie Ihr Ziel documentation comments zu NO wird den trick tun.
    5. Das Ergebnis wird wie folgt Aussehen:

    Deaktivieren Sie die

    • Dokumentation Warnungen immer noch angezeigt, nachdem Sie die Schritte in deiner Frage, auch nach dem reinigen wieder aufgebaut
    • überprüfen Sie, ob beide Ziele und Projekt Documentation Comments wählen Sie "Ebenen" in der oberen linken Ecke, um zu sehen, was die Resolved Ergebnis ist, und was Sie außer Kraft setzen .
    • Ich hatte zu drehen Dokumentation Kommentare deaktiviert, wenn die Option meine Hülsen sub-Projekt, um die Warnungen zu verschwinden.
    InformationsquelleAutor wj2061
  3. 8

    Was zu ignorieren Warnung kommt aus der Bibliothek Hinzugefügt von cocoapods?

    In Ihrem podfile, fügen Sie

    inhibit_all_warnings!

    entfernen Sie alle warn -

    Oder

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

    entfernen Warnungen von bestimmten Bibliothek.

    • Dies funktioniert nicht für die Dokumentation
    • Danke. Dies funktioniert für mich.# Uncomment the next line to define a global platform for your project platform :ios, '10.3' inhibit_all_warnings! pod 'RealmSwift'
    InformationsquelleAutor Y.Bonafons
Schreibe einen Kommentar