The Doxygen build process puts html files into the doc/html/ directory, and latex filex into the doc/latex/ directory. The doc/ directory contains configuration for Doxygen (nf) and main.h. Tab autocompletes common prefix, you can copy a link to the result using L while M produces a Markdown link. Use / to navigate through the list, Enter to go. You can omit any prefix from the symbol or file path adding a : or / suffix lists all members of given symbol or directory.
Type "./ns3 docs doxygen" or "./ns3 docs doxygen-no-build" to build the documentation. Search for symbols, directories, files, pages or modules. Additional ns-3 project documentation can be found at the project web site.īuilding ns-3 Doxygen requires Doxygen version 1.8 at a minimum, but version 1.9 is recommended to minimize warnings. This project uses Doxygen for building the definitive maintained API documentation. Doxygen is typically used for API documentation, and organizes such documentation across different modules. LoRaMac-node Doxygen Documentation v4.6.0. For a detailed information about versions, please visit the changelog. Cortex specific featuresĪnalog Inputs, potentiometer, accelerometer etc.Ns-3 documentation is maintained using Doxygen. LoRaMac-node Doxygen Documentation Overview This page lists the documentations for the most recent versions of the doxygen documentation for the LoRaMac-node repository on GitHub. Thread-safe memory heap and memory pool allocators. Synchronous and asynchronous I/O with timeout capability Mutexes with support for the priority inheritance algorithm
Round-robin scheduling for threads at the same priority level A few demo programs are included that can be used as a starting point for user projects. The idea is that a Markdown-formatted document should be publishable as-is, as plain text. It is a plain text formatting syntax written by John Gruber, with the following underlying design goal: The design goal for Markdown's formatting syntax is to make it as readable as possible.
Modification of the low level drivers could cause damage to the cortex hardware, however, under most circumstances user code can be developed that is as robust as the existing environments for the cortex.įollow the steps outlined in the Getting Started section to install ConVEX and the necessary tools. Markdown support was introduced in doxygen version 1.8.0. Studio llvm-project 110 13,491 10 Doxygen is used to build documentation for.
yet experimental doxygen-generated source code documentation) The system. to clangd/clangd development by creating an account on GitHub This only.
For Windows, visit the downloads page and scroll down to download the installer, then run it to install. On Mac/Linux we suggest using brew or apt-get or whatever package manager you have. The library adds the necessary functionality to allow C applications to be created and executed on the cortex that can access its available hardware.ĬonVEX is not trying to be competitive with ROBOTC or Eas圜, it is only appropriate for advanced users who have some familiarity with RTOS concepts and are comfortable with programming micro-controllers at a bare bones level.ĬonVEX uses many features of the ChibiOS/RT library and the hardware abstraction layer it provides for the STM32 processor. Create Ceph keyring file in /etc/ceph/ceph git Create New Cluster Config A. Doxygen runs in the command line, and is available for Mac, Win and Linux. The ConVEX firmware library is an add on package for the ChibiOS/RT operating system that supports the VEX cortex microcontroller.