From de290eaa23dc9d16296162f0ff52ed00f506e786 Mon Sep 17 00:00:00 2001 From: Sergey Matveev Date: Sun, 27 Sep 2020 12:39:38 +0300 Subject: [PATCH] =?utf8?q?=D0=92=D1=8B=D0=BB=D0=BE=D0=B6=D0=B8=D0=BB=20doc?= =?utf8?q?stringer.pl?= MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit 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, сохраняя его отренедеренное представление в отдельной директории из которой уже и будет делаться дока. Полгода это работает всё на ура. -- 2.48.1