Заставить доксиген работать с Solidity

Question

Я изучаю идею использования doxygen для документирования кода Solidity. Solidity достаточно близко к C# и другим C-подобным языкам, и я могу получить достойный результат, сказав doxygen для интерпретации .sol файлов как .cs и написав инструмент для массажа исходных файлов в соответствии с C# синтаксис.

Проблема в том, что doxygen рассчитывает работать с классами, а Solidity вместо этого имеет контракты и библиотеки. В результате в сгенерированной документации ссылки на заголовки всех разделов и, следовательно, вместо этого ссылаются на «Классы».

Можно ли каким-либо образом изменить HTML-код на «Контракт» или «Библиотека» вместо «Класс», в зависимости от ситуации?

Answer 1

У этого вопроса есть ряд аспектов, некоторые мысли:

• ввод
  • код должен быть преобразован в формат, понятный doxygen. Лучше всего сделать это на начальном этапе, так как я думаю, что на данном этапе с помощью INPUT_FILTER см. Документацию по Doxygen, но немного надумано создать сканер кода, колоратор кода и т. Д. Для этого.
• выход
  • , поскольку термины для Solidity не известны, можно было бы изменить все слова с помощью сценария постобработки. Это довольно громоздко и также подвержено ошибкам, поскольку некоторые слова могут присутствовать и в обычных текстах.
  • создайте локальную (!) Версию doxygen и измените строки на translator_.. естественного языка, который вы используете, и используйте его для генерации документации.