README.md · SourceDocsSwift

git.iko.soy/SourceDocsSwift

39 lines 1.5 kB history raw

1# SourceDocsSwift

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

5## Установка

7```bash

8brew install ilyakooo0/tap/sourceDocsSwift

9```

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

13```bash

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

15```

17```bash

18sourceDocsSwift -s tech -l 2

19```

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

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

25```LaTeX

26\include{doc}

27```

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

31```LaTeX

32\usepackage{longtable}

33```

34### Параметры

36- `[-s | --style] [latex | tech]` -- стиль команды самого внешнего уровня

37- `[-l | --level] [1 | 2 | 3]` -- отступ в уровнях

38- `[-i | --input] path/to/projectDirectory` -- путь к папке с проектом

39- `[-o | --output] path/to/output.tex` -- путь к фалу, в который писать результат