Как создать HTML-документацию для SWIFT-файлов в Xcode с помощью HeaderDoc?

Я пытался документировать свой Swift проект в Xcode с HeaderDoc, но обрабатываются только файлы ".h "и игнорируются файлы".Свифт "

Это мой файл swift: 

/// test
///
/// :param: ann blabla
func testFunc( ann: Foo ) { .. }

Я запускаю в терминале следующее:

headerdoc2html -o ~/Desktop/docum Ninja

This is the error:

    Documentation will be written to /Users/me/Desktop/docum
    HTML output mode.
    No valid input files specified. 

        Usage: headerdoc2html [-dq] [-o <output directory>] <input file(s) or directory>.

    iMac:MyApp me$  headerdoc2html -o ~/Desktop/docum Ninja/

    Documentation will be written to /Users/me/Desktop/docum
    HTML output mode.
    DIR Ninja/
    ======= Parsing Input Files =======

    Processing Ninja/Test.m
        Skipping. No HeaderDoc comments found.

    Processing Ninja/-Bridging-Header.h
1 11
ios shell swift headerdoc

1 ответ:

Да...

На данный момент HeaderDoc не может конвертировать встроенную документацию Swift в HTML-файлы с помощью headerdoc2html. Вам и всем (включая меня), к сожалению, придется подождать.

Другие варианты

Так что "большая тройка" прошивкой инструменты документирования кода HeaderDoc, AppleDoc и Doxygen для документирования. К сожалению, все три не поддерживают Swift. Хорошие новости: AppleDoc выходит с v3.0 относительно скоро, а два других могут (вероятно будет) и обновления, а также. AppleDoc-это открытый исходный код, поэтому, если вы разбираетесь в коде, вы можете адаптировать его под свои нужды (с помощью swift и всего такого джаза)

Правка:

Я прокомментировал страницу AppleDoc на Github и получил пару ответов. В основном, 16 октября 2014 года apple проводит конференцию. После этой конференции ребята из AppleDoc (девчонки?) начнет добавлять поддержку Swift в AppleDoc 3.0, и в какой-то момент он будет выпущен.

Кстати о джазе

Jazzy что-то не так прямо сейчас (!) и может генерировать документацию в виде HTML для Swift (!!) Мне было трудно настроить его, и его формат неортодоксален, но если вы не можете дождаться обновления большой тройки, это может быть только для вас.

Удачи вам в вашем приключении.

ZR

20