Как создать 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

Да...

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

Другие опции

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

EDIT:

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

Говоря о джазе

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

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

ZR