The kernel-doc format is deceptively similar to gtk-doc or Doxygen.
Setting up doxygen (1.8.7-2~trusty1) ~ $ which ~ $ doxygen -version The Linux kernel uses Sphinx to generate pretty documentation from reStructuredText.
Processing triggers for man-db (2.6.7.1-1ubuntu1). 465722 files and directories currently installed.) Selecting previously unselected package doxygen. Get:1 rosa/import doxygen amd64 1.8.7-2~trusty1 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. As a result, it runs on most other Unix flavors as well.
Doxygen linux kernel mac os x#
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. The CAN Ethernet Gateway converts a CAN (controller area network) signal into an ethernet signal. 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. A linux kernel module Gateway for bidirectional translation. Step 1: Download and install Doxygen on Linux So head over to the Doxygen official website given in the link below and download the latest release of Doxygen.
Doxygen linux kernel how to#
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. How it works In this article, our focus will be on how to get started to actually start using Doxygen. This article introduces the usage of Doxygen, and generates data structure for Linux kernel project. Doxygen: Generate Documentation from Source Code
0 kommentar(er)
