Post marked as Apple Recommended
Hi,
I believe its pretty clear but to confirm, does DocC work with Objective-C based products, i.e static frameworks / libraries?
Post marked as Apple Recommended
I'm still using all business logic in Objective-C++ for easier use of our C++ code.
Looks nicer than what I get from Doxygen
Post marked as Apple Recommended
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?
Post not yet marked as solved
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.
Post not yet marked as solved
if I change my project to Xcode 13, we face tab bar tint color issues, split view navigation issues, and navigation bar tint color issues.
Post not yet marked as solved
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
I found out docC is missing search field in hosted documentation, that is currently for example in documentation tool jazzy (https://pspdfkit.com/blog/2016/adding-live-search-to-jazzy/).
This is useful feature that should have every documentation. I would consider it as one of the vital feature for every documentation.
Could we expect this feature someday ?
Thanks for answer.
Post not yet marked as solved
In this documentation: distributing-documentation-to-external-developers, it seems that .doccarchive file can only be opened directly in Xcode or hosted in a website.
In my circumstance, I am distributing my swift static framework by turning on BUILD_LIBRARY_FOR_DISTRIBUTION. There are some symbols such as struct/class/function/property, and they must be marked as public to meet the requirement of compiler. But I really discourage my clients to use these symbols.
One of the approach is to remove them from the code completion suggestion of Xcode.
In another documentation: documenting-a-swift-framework-or-package, it is said that:
The compiler integrates directly with Xcode to enhance your existing workflow, including code completion, Quick Help, and more.
I am wondering if it is possible that I ship my framework with a .doccarchive file. And when my clients use my binary framework, Xcode can use my .doccarchive file when doing code completion and showing quick help of the code?
mervyn.ong.