avelure / doxygen-verilog

Doxygen with verilog support

Fork

This fork contains the patches from Doxverilog 2.8 which have been updated and applied to latest Doxygen release

Doxygen

Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D.

Doxygen can help you in three ways:

1. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in LaTeX) from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, DocBook and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.
2. You can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. Doxygen can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.
3. You can also use doxygen for creating normal documentation (as I did for the doxygen user manual and doxygen web-site).

Download

The latest binaries and source of Doxygen can be downloaded from:

• http://www.doxygen.org/

Developers

• Build Status:

• Coverity Scan Build Status:

• Doxygen's Doxygen Documentation:

• Install

  • Quick install see (./INSTALL)
  • else http://www.doxygen.org/manual/install.html

• Project stats: https://www.openhub.net/p/doxygen

Issues, bugs, requests, ideas

Use the bug tracker to report bugs:

• current list:
  • Bugzilla
• Submit a new bug or feature request
  • Enter bug

Comms

Mailing Lists

There are three mailing lists:

• [email protected] - Announcement of new releases only
• [email protected] - for doxygen users
• [email protected] - for doxygen developers
• To subscribe follow the link to
  • http://sourceforge.net/projects/doxygen

Source Code

In May 2013, Doxygen moved from subversion to git hosted at GitHub

• https://github.com/doxygen/doxygen

Enjoy,

Dimitri van Heesch (dimitri at stack.nl)

doxygen-verilog's Issues

Cygwin : performing test iconv_compiles - failed

The iconv_complies test keeps failing. This is the CMakeError.log file that is created.

Performing C++ SOURCE FILE Test ICONV_COMPILES failed with the following output:
Change Dir: /cygdrive/c/build/CMakeFiles/CMakeTmp
Run Build Command(s):/usr/bin/make.exe cmTC_b501a/fast
/usr/bin/make -f CMakeFiles/cmTC_b501a.dir/build.make CMakeFiles/cmTC_b501a.dir/build
make[1]: Entering directory '/cygdrive/c/build/CMakeFiles/CMakeTmp'
Building CXX object CMakeFiles/cmTC_b501a.dir/src.cxx.o
/usr/bin/c++.exe -DICONV_COMPILES -o CMakeFiles/cmTC_b501a.dir/src.cxx.o -c /cygdrive/c/build/CMakeFiles/CMakeTmp/src.cxx
/cygdrive/c/build/CMakeFiles/CMakeTmp/src.cxx:1:10: fatal error: iconv.h: No such file or directory
#include <iconv.h>
^~~~~~~~~
compilation terminated.
make[1]: *** [CMakeFiles/cmTC_b501a.dir/build.make:66: CMakeFiles/cmTC_b501a.dir/src.cxx.o] Error 1
make[1]: Leaving directory '/cygdrive/c/build/CMakeFiles/CMakeTmp'
make: *** [Makefile:121: cmTC_b501a/fast] Error 2
Source file was:
#include <iconv.h>
int main() {
iconv(iconv_t(-1), 0, 0, 0, 0);
}

Latest version of code uses "V", instead of "VERILOG" as language name in doxygen-config.

Hello, everyone.

I THINK this is a bug. It contradicts the few doxygen-verilog usage examples I could find on the web. The generated comments for doxygen-config don't mention "V" or "Verilog" as an available option, either.