As a result, it runs on most other Unix flavors as well. DOXYGEN VERILOG MAC OS XYou can also use doxygen for creating normal documentation (as I did for the doxygen user manual and web-site).ĭoxygen is developed under Mac OS X and Linux, but is set-up to be highly portable. 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. This is very useful to quickly find your way in large source distributions. DOXYGEN VERILOG CODEYou can configure doxygen to extract the code structure from undocumented source files. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in ) from a set of documented source files. Doxygen also supports the hardware description language VHDL. If you have Dot installed, you will get about 38Mbytes of html data to browse at your leisure.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, and to some extent D. When you've edited the configuration file to match your situation (remember you may have to tell it that you don't have Dot if you don't have Dot, by setting HAVE_DOT = NO), then just run doxygen as follows doxygen systemc201cfg The configref file is here, the SystemC 2.0.1 file we used is here, and the differences file is here. (Note: you may have to right click on the following links and click "save as", otherwise the files will just open in your browser). This file of differences shows you what we had to edit to get doxygen working. You can also download a file of differences between our configuration file and the default. To save you a bit of trouble, you can download our configuration file here. You need to specify directories to search, whether you have Dot or not, which file extensions to search for, and so on. You can create a reference configuration file by running doxygen -g configrefĪnd then edit the default file. Configuring Doxygenĭoxygen can be configured using a text configuration file directly, or using a front-end GUI configuration editor "doxywizard". DOXYGEN VERILOG INSTALLNote that if you want Graphviz/Dot, you should install Graphviz before you install Doxygen. On Linux RedHat 7.3, we downloaded an rpm of Graphviz, and then installed Doxygen from source using gcc 2.95.3. Graphviz is available here.īoth tools can be downloaded and installed straighforwardly from source on Unix platforms. What this means is that you get prettier pictures if you have Graphviz. For the best results, Doxygen can make use of a tool called Dot, which is supplied as part of the graphics visualization library Graphviz. Fortunately for SystemC (which doesn't have such meta-comments!) it can also be made to extract absolutely everything. It was written to scan through programs and automatically generate documentation based on meta-comments added to the program.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |