I created a doccarchive that supports objc and swift using xcode build setting DOCC_EXTRACT_SWIFT_INFO_FOR_OBJC_SYMBOLS. When I made a docc document, I can select objc or swift on Xcode documentation like the yellow box of the below image. However, when I rendered to a web server, that selection link is gone. Blue box of the 2nd image works different way with yellow box of 1st image. The yellow one shows all functions. Even functions not written in that language are converted to other languages and displayed. But the blue one shows functions only written in the selected language. Rendering follows.. https://developer.apple.com/documentation/xcode/distributing-documentation-to-other-developers#Host-a-documentation-archive-on-your-website

I am reluctant to admit that I only came to know that Swift provides a builtin documentation markup syntax just a few months ago. /** Test func Some description here. - Parameters: - b:Test - d: Test - f: Test - Returns: Bool */ func myMethod(a b:Int, c d:Int, e f:Int) -> Bool { b > d } It seems the markup is pretty simple and has only a few keywords. But, I want to read through the complete reference. Any useful pointers?

The idea is to make it easer to update documentation when API changes or when code is not correct. Is it possible to make the code file declared like this: @Code(name: "AppDelegate.swift", file: AppDelegate.swift) And the content of the AppDelegate.swift file is: import UIKit @main class AppDelegate: UIResponder, UIApplicationDelegate { func application( _ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? ) -> Bool { compiler error should be raised here return true } } After doing "Product > Build Documentation" the output gives the following documentation and there is not warning or errors during the build: Thank you for your answers.

Intro I have a framework A and its dependency B. I wrote some documentation using DocC syntax for only framework A and would like to compile documentation for only this framework using Xcode and doing the following steps: Choose a right scheme of framework A Product → Build Documentation (⌃ ⇧ ⌘ D) Expected A generated documentation for only framework A. In fact It tries to compile a doc not only for framework A but for dependency B as well. Problem Unknown reason of failure. It happens because Xcode tries to create a doc for dependency B as well. Questions Is there any way to configure the process of building a doc excluding unnecessary files and paths? If 1st question yes, so where and how? Does a selected scheme affect on DocC compiler process at all? Or the compiler tries to handle all sources he has within .xcworkspace including all .xcodeproj and their dependencies inside workspace? Details Build Documentation_2023-10-20.txt.txt FYI Software: Version: Xcode → 15.0 Swift → 5.9 Dependency B (Realm) → 10.43.1 All the best, Ivan. P.S. I'd been happy to see support Markdown's tables here with more rich visual experience.

Can DocC exclude some struct like swiftUI previews?

Does anyone know of an ePub link to the 5.9 version of the Swift Programming Language docs? While I appreciate them supporting the documentation in DocC format, it would still nice if I could import an ePub (or PDF) copy into iBooks, for the times that I'm disconnected. Would help with bookmarking as well.

Hi, I see that @_documentation(visibility: ...) is available and I have it working for swift source files when using DocC. My question is how to do the same thing for c source (the .h header files specifically)? I haven't been able to find a way to exclude methods or variables in c code from the documentation DocC creates. I'd also be fine with excluding c header files entirely from DocC. Is this available? If so, how could it be done? Mark

Hello! I have a static lib project in Objective-C, in the project I have set... Build Documentation During 'Build' -> Yes Build Multi-Language Documentation for Objective-C ony Targets -> Yes The documentation viewer opens after that, but the target is not present under Objective-C?

DocC is a documentation compiler. Being a compiler, it would make sense that when moving from the Markdown representation to a HTML representation there would be some intermediate output -- an AST, etc. I am wondering if and how one could get access to the AST, for example, representation of the documentation...?

The video shows you can use a 'DocC Archive Hosting Base Path' to incorporate when building the Documentation via Xcode's Build Documentation action. However, for Swift Package only projects this isn't possible since we cannot provide build settings.

For some reason, when I try to command + click on a link in certain parts of the documentation, it does not open it in a new tab. Link here: Getting Started with Scrumdinger The incorrect behavior occurs with the first two links: The Basics and Closures Command+Click to open in a new window works in other parts of the page, and every where else in Safari. I have verified that my settings are correct. This is not user error.

I'm trying to find a more efficient way to generate the Apple-style /// code comments in Xcode. Although I can use Cmd + Option + Enter to automatically generate ///, it's not as convenient when copying(press option to select specific area) and pasting code. Is there a more streamlined approach to generate these comments, especially when pasting existing code? It's convenient to generate doc with old /** */

Hello, everybody. I'm Mauricio Paternina, an aspiring iOS Developer from Colombia. I have a strong interest in translating the Apple Developer Documentation into Spanish for two reasons: on one hand, I'd be able to dive deeper into the documentation itself and cement my knowledge, and on another hand, non-English speakers will be able to navigate and consume the contents of the Documentation, thus, reaching a wider audience. I'm currently the owner/maintainer of an ongoing effort to translate The Swift Programming Language book into Spanish as well. You can check the live site at https://swiftbook.es/. The site has been accepted by The Swift.org Working Development Group as the "official" Spanish translation and it's currently linked on their website. Back to my initial point, I'd tried reaching out to all possible channels to get guidance on how to request or proceed with this, or at least to know if this is even possible/allowed by Apple and I've found myself with no other clue than posting here hoping to find some clarity. I'd like to thank you in advance for any help you might be able to provide. P.S. I used a random tag for the sake of compliance with the posting requirements.

I've been using Xcode and Objective-C for years, and rely heavily on the built-in documentation, which is for the most part good.There's an issue that's always bothered me. Today I was looking up a function called class_getName. I found its documentation page, and was also able to navigate to the page showing the overview of the runtime system, all of which is fine.When I typed "class_getName" into my program, the compiler immediately flagged it as an unknown symbol.I knew I probably had to include a header, but none of the documentation pages I looked at mentioned the name of the header file. I had to end up searching the internet for examples until I hit one that showed <objc/runtime.h> being imported.Why isn't this very small, simple and extremely useful bit of information included in the documentation?Frank

Hello, everyone. I'm new here, so I'm unsure if this is the right place for this inquiry. I'm Mauricio Paternina, a beginner iOS Developer, interested in bringing Swift Development closer to Spanish speakers. I created the site for the Spanish translation of The Swift Programming Language book (which can check here) and I'm interested in translating the Apple Developer Documentation if that's possible. I noticed that the site already has Korean and Chinese translations. Are those provided by Apple directly or by some Korean/Chinese community members? Is it even possible to consider an initiative to translate into Spanish? I appreciate any information you might be able to provide for me to guide through this initiative.

Using Xcode 14.2, Swift 5.7. Workspace with two projects. Both projects comprised of Swift and Obj-C files. Docc generated documentation for one of the projects contains both Swift & Obj-C API documentation. The other only contains Swift API documentation. Looked at the build logs, and the project with both languages output runs through the following documentation-related steps: WriteAuxiliaryFile (extractapi) ... ExtractAPI ... ConvertSDKDBToSymbolGraph ... CompileDocumentation ... The other, that only generates Swift API documentation has these steps: WriteAuxiliaryFile (extractapi) ... CompileDocumentation ... Looking for ideas on how to ensure ExtractAPI and ConvertSDKDBToSymbolGraph steps occur for the latter project. Believe those steps are the reason for missing Obj-C documentation. Is there a build setting (or some other setting) missing that leads to no Obj-C API documentation?

I'm getting the following error messages from xcodebuild when building my swift package from the command line. It's not causing the build to fail or anything, but I'd rather be safer and fix this so that xcodebuild is happy. Is there any particular reason for this error popping up? My swift package contains three modules and each one is getting a similar error. 2023-02-04 23:58:32.550 xcodebuild[52859:2346817] [MT] IDEFileReferenceDebug: [Load] <IDEFileReference, 0x600000d67c00: name:Documentation.docc path:absolute:/Users/trevorhafner/Desktop/PERSONAL STUFF/App DEV/TransportBase/Sources/ColorBase/Documentation.docc> Failed to load container at path: /Users/trevorhafner/Desktop/PERSONAL STUFF/App DEV/TransportBase/Sources/ColorBase/Documentation.docc, Error: Error Domain=com.apple.dt.IDEContainerErrorDomain Code=6 "Cannot open "Documentation.docc" as a "Folder" because it is already open as a "Swift User Managed Package Folder"." UserInfo={NSLocalizedDescription=Cannot open "Documentation.docc" as a "Folder" because it is already open as a "Swift User Managed Package Folder".}

Xcode 14's release notes say that DocC now supports Objective-C and C APIs. To clarify, does this mean that C++ and Objective-C++ APIs are not yet supported? I was attempting to convert from Doxygen, but the document build fails with the error Command ExtractAPI failed with a nonzero exit code on the first line of the header citing the first line: #include <string>.

I'm now using Xcode 14.2 (14C18) and I'd like to the documentation features working again. The integrated documentation used to work in Xcode 13, but sporadically stopped working when I upgraded to Xcode 14. I recently noticed that there is now an explicit Product > Build Documentation command. When I run that, I get a bunch of failures. (Note that this is a large project with many targets, all of which build and archive OK.) The problem seems to be that all of the files (specifically some .h files) are getting compiled/scanned separately. Even ones that aren't included anywhere (for historical reasons). So I end up with failures for lines like this one: #error class unimplemented /* the sockets interface was never used */ This error doesn't occur during regular compilation, because the .m file that includes it is not included in any targets. Now some of these I could clean up, but the next error has me completely stumped. I have a simple "version.h" file that defines the following symbols: #define PRODVERSION_MAJOR 3 #define PRODVERSION_MINOR 0 #define PRODVERSION_FIX 0 #define PRODVERSION_BUILD 73 #define PRODVERSION_NUMERIC 3.0.0.73 The last line fails with the error "invalid suffix .0.73 on floating constant" Which makes me think that the preprocessor used by the document compiler is trying to interpret this symbol as a floating point number and failing. So is there away around this? I'm specifically wondering if there are preprocessor symbols defined by the documentation compiler that can be used (i.e. #ifndef __DocC__...) to exclude code from the documentation build.

When the package, framework, and a type have basically the same name, how do I get DocC to render my custom landing and type pages instead of the defaults? Sometimes I get my landing page to render, sometimes the data type's, never both, often neither Some readers want more of the story: Use case: My package is named SlothWatcher. One of the source files is SlothWatcher.swift, which implements enum SlothWatcher, which serves as a namespace for various constants and functions. I think it's totally reasonable (and common?) to: Name the package SlothWatcher. Name the backbone namespace enum SlothWatcher. Name the file defining the backbone namespace SlothWatcher.swift Enter DocC Now I want DocC to generate documentation. DocC adds some requirements, which are all or some combination of: The docc documentation catalog must be named SlothWatcher.docc. The landing page for the documentation catalog, if overriden, must be named SlothWatcher.md. The first line of that file must be # SlothWatcher (name in double-backticks). All documentation referring to the enum docs must use SlothWatcher/SlothWatcher. Certainly in body text, and I've tried it both ways as the header for the enum extension. If there's a naming rule for the enum extension file, I haven't found it. (Other than that you can't easily put a slash into a file name.) I've lost track. Some of these may not be required at all, given that Xcode defaults none of them. How, if at all, can I get this into working order?