DocC Documentation for targets other than static and dynamic libraries

Is it possible to add DocC documentation to a target that does not result in either a static library or a framework? It doesn't yet appear to be a feature of DocC. If not, will there be support in the future to add documentation to "regular" Xcode projects that don't result in a static library or framework? I think it could be useful to have documentation for larger apps that may use multiple frameworks in complex ways

Up vote post of maxwellpirtle Down vote post of maxwellpirtle
345 views
Posted by
maxwellpirtle
Reply
Add a Comment

Accepted Reply

It doesn't yet appear to be a feature of DocC.

Correct.

If not, will there be support in the future to add documentation to "regular" Xcode projects that don't result in a static library or framework?

I can’t predict the future. What I can say is:

  • This is a much-requested feature.

  • Normally in such cases I’d suggest that you file an enhancement request for that feature, but in this case I think the team already has a good understanding of its importance.

  • There’s been discussions about this over on Swift Forums > DocC (sorry I can’t find the link to the specific thread).

  • DocC is an open source project, and I encourage you to get involved.

Share and Enjoy
—
Quinn “The Eskimo!” @ Developer Technical Support @ Apple
let myEmail = "eskimo" + "1" + "@" + "apple.com"

Posted by
eskimo
Up vote reply of eskimo Down vote reply of eskimo
Post marked as solved
Add a Comment

Replies

It doesn't yet appear to be a feature of DocC.

Correct.

If not, will there be support in the future to add documentation to "regular" Xcode projects that don't result in a static library or framework?

I can’t predict the future. What I can say is:

  • This is a much-requested feature.

  • Normally in such cases I’d suggest that you file an enhancement request for that feature, but in this case I think the team already has a good understanding of its importance.

  • There’s been discussions about this over on Swift Forums > DocC (sorry I can’t find the link to the specific thread).

  • DocC is an open source project, and I encourage you to get involved.

Share and Enjoy
—
Quinn “The Eskimo!” @ Developer Technical Support @ Apple
let myEmail = "eskimo" + "1" + "@" + "apple.com"

Posted by
eskimo
Up vote reply of eskimo Down vote reply of eskimo
Post marked as solved
Add a Comment

I can’t predict the future.

Oooh, it seems like the future is now! Xcode 13.3 Beta Release Notes says:

Xcode can now build documentation from your Swift code in executable targets, like apps and command-line tools. (79155998) (FB9156246)

I haven’t had a chance to try it for myself yet but I’m definitely looking forward to that.

Share and Enjoy
—
Quinn “The Eskimo!” @ Developer Technical Support @ Apple
let myEmail = "eskimo" + "1" + "@" + "apple.com"

Posted by
eskimo
Post not yet marked as solved Up vote reply of eskimo Down vote reply of eskimo

  • Excellent! Excited to try it out

    —
    maxwellpirtle

  • Let us know how you get along. I'm excited about this too, but I'm too snowed under with other work right now to test it for myself.

    —
    eskimo
Add a Comment