For instance: INPUT += PageOrder.doxĪnd you add all the page references in a PageOrder.dox file: \page developers Developers What I found is that if you wish to maintain using directory paths in your Doxygen configuration file, you can create an 'page order' file to parse first before any other content.
For instance, you can achieve the desired order by specifying your files manually such as: INPUT = Developers.dox \ Just as mentions, the current way to ensure a desired order of pages in Doxygen is to ensure the page conditions (\page) are parsed in the same order. It would probably be a good experience for you to read a few coding style documents to see how they differ and how you feel about the differences. However, you should use a consistent and defensible style. JSON output, for example the end-user client software, may present this to the end-user directly or it may apply some pre-processing.After some investigation, it seems Doxygen currently does not support the ordering of pages in a custom (or any) fashion. Dont worry-for 15-410, we arent going to tie you down that much.
Doxygen custom tags code#
Source code to the JSON output as described in this guide. The Solidity compiler will pass through NatSpec documentation from your Solidity They can be used everywhere and are part of the developer documentation. Then use multiple statements in the same format as the statements.Ĭustom tags start with and must be followed by one or more lowercase letters or hyphens. If your function returns multiple values, like (int quotient, int remainder) In the same way as if it were tagged with title that should describe the contract/interfaceĬontract, library, to an end user what this doesĬontract, library, interface, function, public state variable, to a developer any extra detailsĬontract, library, interface, function, state variable, a parameter just like in Doxygen (must be followed by parameter name)įunction, the return variables of a contract’s functionįunction, public state all missing tags from the base function (must be followed by the contract name)įunction, public state tag, semantics is application-defined Used then the Solidity compiler will interpret a /// or /** comment 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. Doxygen provides a large number of special commands, XML commands, and HTML commands. 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 Simple aliases Aliases with arguments Nesting custom command. 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).
Doxygen custom tags free#
This tag tells Doxygen that this is a free floating page and allows doxygen to name the page so that otehr pages can reference and link to the page. Time that they will interact with the contract (i.e. This tag allows you to describe what the function is returning. These messages may be shown to the end user (the human) at the Note that for custom extensions you also need to.
This documentation is segmented into developer-focused messages and end-user-facing 43, If the CREATESUBDIRS tag is set to YES, then doxygen will create. Please carefully examine the supported tags While it uses Doxygen-style comments and tags, there is no intention to keep