You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 1, 2023. It is now read-only.
My original motivation for swift-doc was to generate documentation for libraries. However, as the tool gains wider adoption, teams will likely want to use it internally for their own apps. The major difference between libraries and apps is that apps are typically much less concerned about ACL (if all of your code is in a single app target, everything "just works").
Rather than force teams to change their code in a way that would otherwise provide no immediate benefit (i.e. sprinkling public throughout their code base), I think it would make sense to provide an option for internal declarations to be included in the generated output.
As far as how this should work:
The current behavior of only looking for public or open declarations should probably continue to be the default.
To help folks who might be confused about nothing happening when they run swift doc generate (documented only some pods #70), we should communicate something like "No public declarations found, set the (option) flag to...).
To accommodate future distinctions, this option should probably take an enumerated value rather than a Boolean. So --minimum-access-level internal instead of --include-internal-declarations.
And, of course, this should be documented. I think a "Getting Started" guide should be considered a P1 for our 1.0.0 release. (Write a "Getting Started" guide #73)
The text was updated successfully, but these errors were encountered:
Uh oh!
There was an error while loading. Please reload this page.
My original motivation for
swift-doc
was to generate documentation for libraries. However, as the tool gains wider adoption, teams will likely want to use it internally for their own apps. The major difference between libraries and apps is that apps are typically much less concerned about ACL (if all of your code is in a single app target, everything "just works").Rather than force teams to change their code in a way that would otherwise provide no immediate benefit (i.e. sprinkling
public
throughout their code base), I think it would make sense to provide an option forinternal
declarations to be included in the generated output.As far as how this should work:
public
oropen
declarations should probably continue to be the default.swift doc generate
(documented only some pods #70), we should communicate something like "No public declarations found, set the(option)
flag to...).--minimum-access-level internal
instead of--include-internal-declarations
.The text was updated successfully, but these errors were encountered: