LaTeX-таблицы всех классов, структур и их полей и методов из проекта Xcode
Go to file
2018-08-29 17:04:10 +03:00
SourceDocsSwift Second column justification. Print error when writing file. 2018-08-29 17:04:10 +03:00
SourceDocsSwift.xcodeproj Initial commit 2018-08-24 17:38:10 +03:00
.gitignore Initial commit 2018-08-24 17:38:10 +03:00
README.md Added styling 2018-08-28 00:41:24 +03:00

SourceDocsSwift

Генернирует LaTeX-таблицы всех классов, структур и их полей и методов из проекта Xcode для вставки в техническую документацию.

Установка

brew install ilyakooo0/tap/sourceDocsSwift

Использование

sourceDocsSwift -i path/to/XcodePrjectDirectory/ -o path/to/output/doc.tex -s latex -l 1
sourceDocsSwift -s tech -l 2

По умолчанию ищет проект в текущей папке и пишет результат в эту же папку в файл doc.tex.

В LaTeX документ можно вставить просто положив рядом с щсновным .tex документом и вставив в нужное место:

\include{doc}

Так же требуется пакет longtable. Если в вашем шаблоне этого еще нигде нет, то где-нибудь в преамбуле надо вставить:

\usepackage{longtable}

Параметры

  • [-s | --style] [latex | tech] -- стиль команды самого внешнего уровня
  • [-l | --level] [1 | 2 | 3] -- отступ в уровнях
  • [-i | --input] path/to/projectDirectory -- путь к папке с проектом
  • [-o | --output] path/to/output.tex -- путь к фалу, в который писать результат