Swift Auto Documentation仅适用于pod文件夹

Question

我正在Swift中编写一个SKD，我有一个示例项目作为目标。目标是用于测试SDK所做的网络调用。

我的项目结构看起来像这样

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

作为'development'子文件夹的文件夹中的所有文件都是注释的swift文件，当点击选项时显示我希望导出的注释

我已经下载了jazzy，但我看不到更多地指定路径扩展的方法，似乎构建项目并取出目标的注释。

但是我不想要这个，因为我的目标中的所有代码都不是我在完成后将要发送的内容。

我的问题是，有没有办法传递文件夹扩展程序，例如（“/ mac / project / target / development”）到jazzy（或任何其他gem或程序），以便我可以自动为我的代码生成文档？或者，在我输入所有内容之前，是否有人知道我可以使用的更好的解决方案或库！

Answer 1

当你运行jazzy -h并且你可以看到

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

玩耍吧:)。

Answer 2

只需写下＆＃39; jazzy --podspec PathOfYourPodspec＆＃39;你应该创建你的文档文件夹。