You can also install doxygen from source code if you like to do so, refer to Doxygen Installation. Setting up doxygen (1.8.7-2~trusty1) ~ $ which ~ $ doxygen -version Processing triggers for man-db (2.6.7.1-1ubuntu1). 465722 files and directories currently installed.) Selecting previously unselected package doxygen. The kernel-doc format is deceptively similar to gtk-doc or Doxygen. Generating the kernel documentation from source. However, people who don't have measurable performance problems should probably avoid littering their code with cryptic incantations without actual benefit. Get:1 rosa/import doxygen amd64 1.8.7-2~trusty1 The Linux kernel uses Sphinx to generate pretty documentation from reStructuredText. People with such concerns should look at the likely() and unlikely() preprocessor macros in the Linux kernel and the associated gcc builtin function builtinexpect(). The following NEW packages will be installed:Ġ upgraded, 1 newly installed, 0 to remove and 4 not upgraded.Īfter this operation, 10.3 MB of additional disk space will be used. The following package was automatically installed and is no longer required: Run the following command to install ~ $ sudo apt install doxygen Furthermore, executables for Windows are available. Linux kernel > 2.6.32 > - > - Earlier versions may or may not work. As a result, it runs on most other Unix flavors as well. You can also use doxygen for creating normal documentation.ĭ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. You 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. Please stick to the style described here. The kernel source contains tens of thousands of kernel-doc comments. 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. The kernel-doc format is deceptively similar to javadoc, gtk-doc or Doxygen, yet distinctively different, for historical reasons. What’s Doxygen?ĭoxygen 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. This article introduces the usage of Doxygen, and generates data structure for Linux kernel project. Doxygen: Generate Documentation from Source Code
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |