Автоматическое формирование документации из исходников

#21

@theshadowco очень даже имеет смысл постить )) Допилим. Я вот уже начал работу в этом направлении https://github.com/khorevaa/oscript-documentator

1 Симпатия
#22

Присоединяюсь. Тоже работаю над документатором API, но делаю не свой фреймворк, а конвертер модулей в java-формат, который уже можно отправить в doxygen. Пока застопорился на парсере модуля, в целом работает, но нет времени допилить нюансы :slight_smile:

#23

На инфостарте вроде была статья про генерацию в доксиджен

Нашёл
https://infostart.ru/public/181935/

#24

С этой статьи я начал исследования данного вопроса.Там софт не очень гибкий - java конвертер, который понимает исходный модуль, только если там методы определены в одну строку, например. Берем БСП, в которой списки параметров вытягиваются в вертикаль, каждый на своей строке, и ловим epic fail.

#25

Поробую в ближайшее время запостить скрипт/библиотеку, отпишусь.

#26

подскажешь?

#27

Коллеги, что-нибудь по автодокументаторам изменилось?

есть какой-нибудь, что сможет сгенерить md-описание по тексту модуля - bsl или os?

#28

Недавно еще один красивый вариант нашелся от @tsukanov-as и его парсера исходников
Запуск: https://github.com/khorevaa/BSL-Parser/blob/develop/tests/oscript/docgen.os
Результат: https://khorevaa.github.io/BSL-Parser/

#29

@JohnyDeath @Khorevaa Я попробовал.

К сожалению, получается именно тот, что на https://khorevaa.github.io/BSL-Parser/
описываются узлы, а методы не документируются.
т.е. документируется именно внутренний формат, а не внешний :frowning:

видимо, где-то что нужно подпилить для получения информации из указанной AST :frowning:

#30

@artbear
Если создашь челобитную с описанием что конкретно нужно, то возможно что то я рожу в итоге.
Этот генератор конечно делался под конкретную узкую задачу. Но сделать универсальный не проблема. Непонятно только что конкретно требуется

#31

ОФФ: челобитная - это PR
а issue именуется досадой :wink: