- Doxygen linux kernel pdf#
- Doxygen linux kernel full#
- Doxygen linux kernel code#
- Doxygen linux kernel windows#
Supports many different character encodings and uses UTF-8 internally and for the generated output.ĭoxygen can generate a layout which you can use and edit to change the layout of each page.
Doxygen linux kernel code#
Inclusion of undocumented classes is also supported, allowing to quickly learn the structure and interfaces of a (large) piece of code without looking into the implementation details.Īllows automatic cross-referencing of (documented) entities with their definition in the source code.Īll source code fragments are syntax highlighted for ease of reading.Īllows inclusion of function/member/class definitions in the documentation.Īll options are read from an easy to edit and (optionally) annotated configuration file.ĭocumentation and search engine can be transferred to another location or machine without regenerating the documentation. Doxygen will convert them to their equivalent, RTF, and man-page counterparts automatically.Īllows references to documentation generated for other (doxygen documented) projects (or another part of the same project) in a location independent way.Īllows inclusion of source code examples that are automatically cross-referenced with the documentation. You can type normal HTML tags in your documentation. Includes an JavaScript based live search feature to search for symbols as you type (for small to medium sized projects). Includes a fast, rank based search engine to search for strings or words in the class and member documentation (PHP based). References to base/super classes and inherited/overridden members are generated automatically. Documentation of global functions, global variables, typedefs, defines and enumerations is also supported. Extraction of private class members is optional.Īutomatically generates references to documented classes, files, namespaces and members.
Doxygen linux kernel full#
Includes a full C preprocessor to allow proper parsing of conditional code fragments and to allow expansion of all or part of macros definitions.Īutomatically detects public, protected and private sections, as well as the Qt specific signal and slots sections. Support for various third party help formats including HTML Help, docsets, Qt-Help, and eclipse help.
Doxygen linux kernel pdf#
All formats are optimized for ease of reading.įurthermore, compressed HTML can be generated from HTML output using Microsoft's HTML Help Workshop (Windows only) and PDF can be generated from the output.
Outputs documentation in on-line format (XHTML and UNIX man page) and off-line format ( and RTF) simultaneously (any of these can be disabled if desired). Generates a list of all members of a class (including any inherited members) along with their protection level. Uses the dot tool of the Graphviz tool kit to generate include dependency graphs, collaboration diagrams, call graphs, directory structure graphs, and graphical class hierarchy graphs.Īllows grouping of entities in modules and creating a hierarchy of modules.įlexible comment placement: Allows you to put documentation in the header file (before the declaration of an entity), source file (before the definition of an entity) or in a separate file. The GUI is available on Windows, Linux, and MacOSX.Īutomatically generates class and collaboration diagrams in HTML (as clickable image maps) and (as Encapsulated PostScript images). Javadoc (1.1), qdoc3 (partially), and ECMA-334 (C# spec.) compatible.Ĭomes with a GUI frontend (Doxywizard) to ease editing the options and run doxygen. Supports documentation of files, namespaces, packages, classes, structs, unions, templates, variables, functions, typedefs, enums and defines. Supports C/C++, Lex, Java, (Corba and Microsoft) Java, Python, VHDL, PHP IDL, C#, Fortran, Objective-C 2.0, and to some extent D sources.
Generates structured XML output for parsed sources, which can be used by external tools. Indexes, organizes and generates browsable and cross-referenced output even from undocumented code.
Doxygen linux kernel windows#
Plain text will do, Markdown is support, and for more fancy or structured output HTML tags and/or some of doxygen's special commands can be used.Ĭross platform: works on Windows and many Unix flavors (including Linux and MacOSX).
Requires very little overhead from the writer of the documentation.
0 kommentar(er)
