Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to export Quick Help Documentation for User Defined Function in Xcode 8 to HTML

Tags:

I know how to add the documentation in Xcode but I am unable to find , how to export that documentation to HTML.

like image 369
ManiaChamp Avatar asked Nov 28 '16 12:11

ManiaChamp


People also ask

How do you document a project in Xcode?

To do this in your own project, right-click on your package's directory in the project navigator, then choose New File. If you scroll down to the Documentation section you'll see Documentation Catalog – select that and click Next, and Xcode will create the catalog for you immediately.

How do I document a swift code?

Swift 5, XCode 11.3+Select the code and then Right click. Save the code snippet and give the completion name as documentation. Now if we start typing documentation, the snippet will be shown in the code completion.

How do I build in Xcode?

To build and run your code, choose Product > Run, or click the Run button in your project's toolbar. Xcode analyzes your scheme's targets and builds them in the proper sequence. After a successful build, Xcode launches the associated app.


1 Answers

There are 2 major apps/command line tools that can do what you want

  • Headerdoc
  • doxygen

Headerdoc

Is an open source documentation to html script/command line tool from Apple, Inc.

Headerdoc is provided by default in all versions of OS X/macOS just open Terminal and use the following to figure out what you have:

which headerdoc2html

and then read the man page using something like this:

man headerdoc2html

Doxygen

Supports many languages and has a few tag/format differences from Headerdoc


Which one you will want to use will be based on what language you are using, Headerdoc may not support the language you want and doxygen might not either, your mileage may vary. Read the documentation and supported languages to make your choice. I hope this helps :)

like image 151
Chucky Avatar answered Sep 24 '22 16:09

Chucky