DocC: How to write content from another file in documentation

Question

Created Jul ’22

Replies 1

Boosts 0

Views 1.6k

Participants 2

I want to lint my documentation without having to run vale checks throughout the code. So I created "testing-docs.md", added content like "This is a testing document for linting checks."

Now in my class, I have added my documentation in comment like stated by Apple.

/// <testing-docs.md>
/// -Parameters:
///   - token: conn123
///   - payload: nothing for now
///   - fromViewController: <#fromViewController description#>
///   - completion: <#completion description#>

Is there a way that instead of <testing-docs.md>, I get the file's content displayed "This is a testing document for linting checks."

I don't want to do it manually because I want to lint content separately.

I have multiple md files.

Answer 1

Engineer OP

Apple

Jul ’22

I think that DocC's documentation extension files will work for your use case here. They allow you to use a markdown file to either override or append to documentation written in a symbol's documentation comment.

You can read about them here: https://developer.apple.com/documentation/xcode/adding-supplemental-content-to-a-documentation-catalog#Add-Extension-Files-to-Append-to-or-Override-Source-Documentation-Comments.