Meet DocC documentation in Xcode

RSS for tag

Discuss the WWDC21 session Meet DocC documentation in Xcode.

Posts under wwdc21-10166 tag

6 Posts

Post

Replies

Boosts

Views

Activity

DocC for something else than Swift.
Hello My projects are all in C and Objective-C and have a 0% chance to ever use Swift (portability is super important for me). However I love to write code in Xcode and the new DocC feature looks like something you definitively want to support. Now I set up a test project and it seems to be that DocC does only work in Swift. If you annotate plain-C functions it produces zero output. Not even a workspace documentation entry pops up. Given Apple has plenty of documentation pointing to Unix C functions and Apple libraries you can call in C, I find it rather strange that this doesn't work. Is this intentionally or am I missing a few additional things to make it work for C?
2
0
1.2k
Jun ’22
Static Hosting Support using DocC
I'm able to create my documentation via Xcode-> Product -> Build Documentation and that creates MY_PROJ.docarchive. I can also create .docarchive using xcodebuild command Now I'm trying to convert/export my .docarchive to host it in static space so that I can host it on Github pages. I'm using https://github.com/apple/swift-docc to convert my docarchive using the following command, swift run docc process-archive transform-for-static-hosting <path/to/docarchive> --output-path <destination_path> I can see the files exported in output-path which I believe is the files that I need to deploy in static hosting space. But when I host the same files in my local server or Github pages, they are still blank. Not sure what's wrong here.
3
0
4.1k
Apr ’22
DocC extension documentation
I built a small swift utility library, playing around with some new features introduced this year, one of them being DocC. I was able to successfully build the documentation https://timekeeper.aplr.io, which works great for all classes and structs, but I can't get DocC to include docs for the public Combine Publisher extension (here). Is there some way to do this or is it just not supported (yet, hopefully). Thanks, Andreas
1
0
613
Nov ’21
DocC for something else than Swift.
Hello My projects are all in C and Objective-C and have a 0% chance to ever use Swift (portability is super important for me). However I love to write code in Xcode and the new DocC feature looks like something you definitively want to support. Now I set up a test project and it seems to be that DocC does only work in Swift. If you annotate plain-C functions it produces zero output. Not even a workspace documentation entry pops up. Given Apple has plenty of documentation pointing to Unix C functions and Apple libraries you can call in C, I find it rather strange that this doesn't work. Is this intentionally or am I missing a few additional things to make it work for C?
Replies
2
Boosts
0
Views
1.2k
Activity
Jun ’22
Static Hosting Support using DocC
I'm able to create my documentation via Xcode-> Product -> Build Documentation and that creates MY_PROJ.docarchive. I can also create .docarchive using xcodebuild command Now I'm trying to convert/export my .docarchive to host it in static space so that I can host it on Github pages. I'm using https://github.com/apple/swift-docc to convert my docarchive using the following command, swift run docc process-archive transform-for-static-hosting <path/to/docarchive> --output-path <destination_path> I can see the files exported in output-path which I believe is the files that I need to deploy in static hosting space. But when I host the same files in my local server or Github pages, they are still blank. Not sure what's wrong here.
Replies
3
Boosts
0
Views
4.1k
Activity
Apr ’22
DocC extension documentation
I built a small swift utility library, playing around with some new features introduced this year, one of them being DocC. I was able to successfully build the documentation https://timekeeper.aplr.io, which works great for all classes and structs, but I can't get DocC to include docs for the public Combine Publisher extension (here). Is there some way to do this or is it just not supported (yet, hopefully). Thanks, Andreas
Replies
1
Boosts
0
Views
613
Activity
Nov ’21