Documentation Tips

This page will collect some tips on how to write and structure documentation so that it fits into the Mbed CE docs.

Running Doxygen Locally

If you have created or edited significant amounts of documentation, it's recommended to run Doxygen locally to check your docs. After installing Doxygen (>=1.9.1), docs can be generated by opening a terminal in the mbed-os root folder and running:

$ doxygen .\doxyfile_options

Docs will be generated in the BUILD folder, and any errors will be printed to the screen.

File Header

At minimum, each file should contain a block like this near the top:

/**
 * \file
 *
 * Copyright (c) 2006-2022 ARM Limited
 * SPDX-License-Identifier: Apache-2.0
 *
 * \brief <one-sentence description of what's in this file>
 */

The \file command tells Doxygen to include stuff from this file in the output docs. The \brief command sets the description of the file.