#Doxygen custom tags generator
#Doxygen custom tags code

The following table explains the purpose of each contract Tree Tags Īll tags are optional. Gardner /// You can use this contract for only the most basic simulation /// All function calls are currently implemented without side effects /// This is an experimental contract. SPDX-License-Identifier: GPL-3.0 pragma solidity >= 0.8. The following example shows a contract and a function using all available tags. These are most likelyĪccomplished via the tag, and a good use case is analysis and verificationĭocumentation is inserted above each contract, interface, library,įunction, and event using the Doxygen notation format.Ī public state variable is equivalent to a functionįor Solidity you may choose /// for single or multi-lineįor Vyper, use ''' indented to the inner contents with bare NatSpec may also include annotations used by third-party tools. Output of the Solidity compiler, which extracts these comments into a machine-readable Use, and which are understood by the Solidity compiler. NatSpec includes the formatting for comments that the smart contract author will It is recommended that Solidity contracts are fully annotated using NatSpec forĪll public interfaces (everything in the ABI). Time that they will interact with the contract (i.e. These messages may be shown to the end user (the human) at the This documentation is segmented into developer-focused messages and end-user-facing Please carefully examine the supported tags While it uses Doxygen-style comments and tags, there is no intention to keep Linked graphical class diagrams, class inheritance tree Internal links between classes, methods, variables, tables, columns.įull customization for all output formats, templates for MSDN-like output, custom XML comment tags Table of Contents, Index cross referencing syntax highlighting with PygmentsĬustom objects (such as functions and classes)ĭocumentation content and styles customizableĬlass inheritance, call trees, dependencies (impact analysis) using aafigure, actdiag, Google Chart, or gnuplot Smarty-based templates (1.x), Twig-based templates (2+)Ĭross reference to generated documentation, and to php.net function referenceġ0 themes Jinja2 templating Python plugins

#Doxygen custom tags code

Source code syntax highlighting, automatic cross-linking to symbol declarations

#Doxygen custom tags generator

Including the binary codes included in the comments.Įxtend the generator classes through Perl programming. Linked hierarchy and dependency graphs for function calls, variable sets and reads, class inheritance and interface, and file includes and interface, intra-function flow chartsįully cross-linked project-wide, including all hierarchy and dependency graphs, metrics tables, source code snippets, and source filesįull semantic analysis of source code, including parameter types, conditional compilation directives, macro expansionsĪll general documentation references, manual, organigrams. Support for #if/#ifdef control over documentation inclusion using the -D and -U command-line flags.Ĭustomizable through style sheets and CSS Partial C preprocessor support with -p flag. Provides warnings if tagged parameters do not match code, parsed parameters included in XML output and Doxygen-style tagfile (-D flag in 8.7). Project-wide TOC is generated from a user-defined template.Ĭonfigurable syntax highlighting/coloring with automatic linking to symbols in declaration, ability to manually link to symbols in discussion, etc. NET framework documentationĬaller and callee graphs, dependency graphs, inheritance diagrams, collaboration diagramsĬustom headers, footers, code coloring, and other CSS styles in individual pages. Linked graphical object relationship diagrams

Highlighting and linking of generated docĬustomizable HTML based templates, custom comment tags

The output formats the generators can write.

Jason Diamond, Jean-Claude Manoli, Kral FerchĪda, C, C++, Fortran, JavaScript, PHP, Python, Ruby Basic general information about the generators, including: creator or company, license, and price.Ĭ++/CLI only, C#, IDL, Java, VB, VBScript, PL/SQLĬ/C++, C#, D, IDL, Fortran, Java, PHP, Pythonįpdoc (Free Pascal Documentation Generator)ĪppleScript, Bash, Csh, C, C++, Delphi, IDL, Java, JavaScript, MIG, Pascal, Perl, PHP, Python, Ruby, Tcl