Выложил docstringer.pl

Что: de290eaa23dc9d16296162f0ff52ed00f506e786

Когда: 2020-09-27 12:39:38+03:00

Темы: doc tip

http://git.stargrave.org/cgit.cgi/dotfiles.git/tree/bin/bin/docstringer.pl
Для доки C проектов я хочу использовать Texinfo (как и для всего). Но
штатной какой-то интеграции, как у Sphinx с Python, нету. А хочется
чтобы в C коде тоже была документация рядом с нужными функциями,
переменными и типами, в виде docstring-ов. Не проблема, уже давно
написал, но только сейчас закоммитил, утилиту для этого самопальную.

В .[ch] файлах если встречается комментарий с TEXINFO: FooBar, то до его
конца он будет считаться текстом FooBar. В .texi файле если будет
встречен @DOCSTRING FooBar@, то это будет заменено на содержимое FooBar
текста. Просто и эффективно. В Sphinx используются :py:... конструкции,
а тут просто DOCSTRING. Утилита сканирует предоставленный C код,
выпирсивает из него текст, а дальше парсит .texi, сохраняя его
отренедеренное представление в отдельной директории из которой уже и
будет делаться дока. Полгода это работает всё на ура.

оставить комментарий

Сгенерирован: SGBlog 0.34.0