One thing that I've liked about Sphinx is that it supports referencing code-comment documentation, but relies on the document author to do so. DOXYGEN VERILOG CODEMy experience has also been that documentation created from API code comments is lacking key insights from the author on the code's architecture. My experience has been that they're a good way to quickly create somewhat-generic documentation, provided the doc-generation tool supports the right coding language and the codebase contains enough comments. Tools that generate documentation from code comments have been around for a long time. That said, its features support documenting far more than just Python code - as we'll shortly see. Sphinx was originally created for documenting Python code, and it shows. Sphinx has a wide variety of plug-ins that help to make formatting different types of document content more productive. Sphinx accepts input formatted with reStructuredText mark-up and generates formatted output in HTML, PDF, and several other formats. DOXYGEN VERILOG GENERATORI've been using Sphinx Documentation Generator for the last couple of years. Consequently, when it comes to documenting APIs, I need to cover a fair amount of ground. But, support for other languages (C, C++, Python, etc) are important as well. SystemVerilog and UVM currently are, after all, the most widely-deployed solution for block- and subsystem-level verification. This post, however, is about documentation and, specifically, documentation for SystemVerilog code.Īs you can imagine, SystemVerilog support is critical for a project that connects into simulation environments. I'll write more (likely much more) about this project in the future. DOXYGEN VERILOG SOFTWAREYou should have received a copy of the GNU General Public License along with this program if not, visit or write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.I've been digging into a project over the last few months whose value proposition is to simplify the process of connecting simulation-like environments and things like reference models, testbench languages, etc. See the GNU General Public License for more details. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. This program is free software you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation either version 2 of the License, or (at your option) any later version. Natural Docs and its derivatives, including this work, are licensed under the GNU General Public License (GPL): Natural Docs then scans your code and builds high-quality HTML documentation from it. You document your code in a natural syntax that reads like plain English. Natural Docs is an open-source documentation generator. ovm/docs/ovm_ref/nd/gen_nd script after reading the documentation contained within it.Īnother good example of ND usage is the recently contributed OVM-VMM Interoperability Supplemental Kit (see It uses custom inline-code tags to insert code snippets and complete code examples directly into the HTML documentation.Īll ND documentation for both users and developers is found at. More importantly, you can use the OVM reference as a template for generating your own documentation. Using the OVM source used as input, you can generate the same online documentation you see at OVM World. This kit provides a modified version of the open-source Natural Docs documentation generator, configuration files, images, and scripts used to generate the OVM Online Documentation.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |