git.iko.soy/SourceDocsSwift
on master help sign in
Fixed a bug and added README
c31f002ilyakooo0
README.md+26
compare with master
unifiedsplit
@@ -1,3 +1,29 @@
1# SourceDocsSwift
1# SourceDocsSwift
2
2
3Генернирует LaTeX-таблицы всех классов, структур и их полей и методов из проекта Xcode для вставки в техническую документацию.
3Генернирует LaTeX-таблицы всех классов, структур и их полей и методов из проекта Xcode для вставки в техническую документацию.
4+
5+## Установка
6+
7+```bash
8+brew install ilyakooo0/tap/sourceDocsSwift
9+```
10+
11+## Использование
12+
13+```bash
14+sourceDocsSwift -i path/to/XcodePrjectDirectory/ -o path/to/output/docs.tex
15+```
16+
17+По умолчанию ищет проект в текущей папке и пишет результат в эту же папку в файл `docas.tex`.
18+
19+В LaTeX документ можно вставить просто положив рядом с щсновным `.tex` документом и вставив в нужное место:
20+
21+```LaTeX
22+\include{doc}
23+```
24+
25+Так же требуется пакет `longtable`. Если в вашем шаблоне этого еще нигде нет, то где-нибудь в преамбуле надо вставить:
26+
27+```LaTeX
28+\usepackage{longtable}
29+```
SourceDocsSwift/main.swift−5
@@ -8,14 +8,9 @@
8
8
9import Foundation
9import Foundation
10
10
11−//let directory = "/Users/ilya/Developer/Dotrix/Dotrix/"
12−//let output = "/Users/ilya/Desktop/foo.tex"
13−
14let args = Array(CommandLine.arguments.dropFirst())
11let args = Array(CommandLine.arguments.dropFirst())
15let temp = FileManager.default.temporaryDirectory.appendingPathComponent("SourceDocsSwift/build\(Date().timeIntervalSince1970)")
12let temp = FileManager.default.temporaryDirectory.appendingPathComponent("SourceDocsSwift/build\(Date().timeIntervalSince1970)")
16
13
17−print(temp)
18−
19var output = "docs.tex"
14var output = "docs.tex"
20var directory: String?
15var directory: String?
21
16