2015-04-22 3 views
2

Проект «doxverilog» больше не поддерживается, авторский сайт не отвечает. Проект http://intelligentdv.com/downloads/index.html#doxygentools работает только для иерархии классов SV. AMIQ http://www.dvteclipse.com/ Specador - продукт, завышенный продукт. Что использовать?Альтернатива Doxygen для Verilog, SystemVerilog?

ответ

0

Для всех, кто ищет документацию для Verilog или SystemVerilog, я бы рекомендовал взглянуть на IDV doxygen filter, указанный в исходном вопросе. Это не ограничивается классами - я нашел его жизнеспособным вариантом в его нынешнем состоянии и считаю, что он также имеет большой потенциал.

Чтобы лучше понять потенциал - в настоящее время я использую это (с несколькими небольшими пользовательскими хаками) для документирования проекта FPGA, написанного в SystemVerilog. Скрипт работает, пытаясь перевести HDL во что-то, что можно проанализировать, как если бы это был C++. Например, мой проект в основном документирует модули, интерфейсы и структуры. Структуры обрабатываются так же, как и в C \ C++, и модули и интерфейсы обрабатываются путем перевода их в функции, где порты документируются как записи @param, а переопределяемые параметры документируются как @tparam записей. Когда код затем выполняется через doxygen через этот фильтр, результатом является то, что каждый модуль и интерфейс документируются как функция с описанием, определениями портов (параметров) и описания переопределяемых параметров (параметров шаблона). Это отличное начало, но есть возможности для улучшения. Например, экземпляры модулей в настоящее время не распознаются как вызовы функций, поэтому doxygen не создает граф вызовов, представляющий иерархию экземпляров. Однако это похоже на возможное повышение.

Обратите внимание, что я связан с репозиторием Github для проекта. Автор, похоже, не активно поддерживает проект, но, возможно, если мы все начнем делать вклады, это может превратиться во что-то, что полностью удовлетворит эту потребность.

Смежные вопросы