Jazzy is not working as expected for generating swift documentation

前端 未结 2 1324
攒了一身酷
攒了一身酷 2021-02-13 13:45

After doing some research on the best way to document swift code. I came across Jazzy and how simple it was to implement. So I follow the installation section of the Jazzy Docum

相关标签:
2条回答
  • 2021-02-13 14:27

    To make it even better. Use
    jazzy --min-acl internal --skip-undocumented
    Explanation :
    --min-acl internal this will include all functions, classes, structs in your documentary
    --skip-undocumented this will ignore all undocumented classes...

    0 讨论(0)
  • 2021-02-13 14:37

    After reading more about jazzy more in depth I found this important piece of information.

    By default, jazzy only documents public declarations. To generate documentation for declarations with a lower accessibility level (internal or private), please set the --min-acl flag to internal or private.

    Which is in the trouble shooting portion of the jazzy git hub page

    I ran jazzy with the following line to produce the documentation i expected:

    jazzy --min-acl private
    

    Note I should read everything before I decided something isn't working right.

    0 讨论(0)
提交回复
热议问题