mirror of
https://github.com/ilyakooo0/SourceDocsSwift.git
synced 2024-10-03 18:27:18 +03:00
LaTeX-таблицы всех классов, структур и их полей и методов из проекта Xcode
SourceDocsSwift | ||
SourceDocsSwift.xcodeproj | ||
.gitignore | ||
README.md |
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
-- путь к фалу, в который писать результат