# Swift Documentation Generator

**URL:** <https://ifnotnil.com/t/swift-documentation-generator/1309>\
**Category:** Other\
**Created:** [9 November 2020 20:05 UTC](https://ifnotnil.com/t/swift-documentation-generator/1309 "2020-11-09T20:05:35Z")\
**Posts on this page:** 5\
**Page:** 1

<div class="post-metadata">

**Author:** ![DaveS](https://ifnotnil.com/user_avatar/ifnotnil.com/daves/32/79_2.png) [@DaveS](https://ifnotnil.com/u/DaveS)\
**Post date:** [9 November 2020 20:05 UTC](https://ifnotnil.com/t/swift-documentation-generator/1309/1 "2020-11-09T20:05:35Z")

</div>

Does anyone here have an interest in an application to automatically generate documentation for an Xcode/Swift project?

I had tried Jazzy in the past, but can’t seem to get it to work with Catalina anymore (keeps complaining about missing manifest)… Not to mention I didn’t really like the output format all that much 🙂

So I am writing my own, unlike Jazzy which uses Xcode to generate various files it needs, mine will simply analyze the text of the code…

So far I have it successfully parsing an Xcode project and dumping the relevant bits to a text file. The next step will be to create a relation database from which it will create either a Markdown or HTML document. …

This app is written 100% in Swift

 ![x](https://ifnotnil.com/uploads/default/original/2X/1/1cd26c78b393558212c65e7a74edf1f84e52c397.png)

---

<div class="post-metadata">

**Author:** ![npalardy](https://ifnotnil.com/user_avatar/ifnotnil.com/npalardy/32/10_2.png) [@npalardy](https://ifnotnil.com/u/npalardy)\
**Post date:** [9 November 2020 21:54 UTC](https://ifnotnil.com/t/swift-documentation-generator/1309/2 "2020-11-09T21:54:01Z")

</div>

The name might get you in trouble

> **[RagTime (software)](https://en.wikipedia.org/wiki/RagTime_(software))**
>
> RagTime is a frame-oriented business publishing software which combines word processing, spreadsheets, simple drawings, image processing, and charts, in a single document/program. It is often used to create forms, reports, documentation, desktop publishing, and in office environments. Typical users are business clients, educational institutions, administrations, architects, and also private users.
> Ragtime includes the following modules:
> RagTime differs from most other comparable programs or sof...

I dont have use for such a thing at this point in time (not to say never though)

---

<div class="post-metadata">

**Author:** ![DaveS](https://ifnotnil.com/user_avatar/ifnotnil.com/daves/32/79_2.png) [@DaveS](https://ifnotnil.com/u/DaveS)\
**Post date:** [9 November 2020 22:10 UTC](https://ifnotnil.com/t/swift-documentation-generator/1309/3 "2020-11-09T22:10:46Z")

</div>

eh… .names are easy to change… Ragtime was a play on “Jazzy”

---

<div class="post-metadata">

**Author:** ![npalardy](https://ifnotnil.com/user_avatar/ifnotnil.com/npalardy/32/10_2.png) [@npalardy](https://ifnotnil.com/u/npalardy)\
**Post date:** [10 November 2020 00:31 UTC](https://ifnotnil.com/t/swift-documentation-generator/1309/4 "2020-11-10T00:31:42Z")

</div>

So it could be “Dizzy” ? 😛

---

<div class="post-metadata">

**Author:** ![DaveS](https://ifnotnil.com/user_avatar/ifnotnil.com/daves/32/79_2.png) [@DaveS](https://ifnotnil.com/u/DaveS)\
**Post date:** [10 November 2020 00:46 UTC](https://ifnotnil.com/t/swift-documentation-generator/1309/5 "2020-11-10T00:46:16Z")

</div>

well… could be… but not 🙂