Jazzy is not working as expected for generating swift documentation Jazzy is not working as expected for generating swift documentation xcode xcode

Jazzy is not working as expected for generating swift documentation


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.


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...