Swift Auto Dokumentation jazzy nur für pod Ordner

Question

Ich schreibe eine SKD in Swift und ich habe ein Beispielprojekt als Ziel. Das Ziel ist dort zum Testen der Netzwerkaufrufe, die das SDK erstellt.

Meine Projektstruktur sieht so etwas wie dieses

-project 
    ->sampleViewController 
    ->storyboard 
    ->plist 
-pods 
    ->core 
    ->development 
     -> Main 
     -> Network 
     -> Objects 
     -> Protocols 
     -> Structs 
    -> RxSwift 
    -> Fakery 
    -> tw10 

alle Dateien in Ordner, die Unterordner von ‚Entwicklung‘ sind alle swift Dateien sind kommentiert und wenn die Option Show geklickt die Notizen, die ich hoffe, ich zu exportieren

Ich habe jazzy heruntergeladen und ich kann nicht sehen, eine Möglichkeit, eine Pfaderweiterung mehr darüber anzugeben, scheint das Projekt zu bauen und die Kommentare des Ziels zu entfernen.

Allerdings möchte ich dies nicht, da der gesamte Code in meinem Ziel nicht das ist, was ich versenden werde, wenn ich fertig bin.

Meine Frage ist, gibt es eine Möglichkeit, eine Ordnererweiterung z. ("/ mac/project/target/development") zu jazzy (oder einem anderen Juwel oder Programm), damit ich die Dokumentation für meinen Code automatisch generieren kann? Oder kennt jemand eine bessere Lösung oder Bibliothek, die ich verwenden könnte, bevor ich alles austippe!

Answer 1

Wenn Sie jazzigen h laufen und Sie können

--source-directory DIRPATH The directory that contains the source to be documented 
-e, --exclude file1,file2,…fileN Files to be excluded from documentation 

Gleich um spielen sehen :).

Answer 2

Schreiben Sie einfach 'jazzy --podspec PathOfYourPodspec' und Sie sollten Ihren Dokumentationsordner erstellen lassen.