Lines Matching full:doxygen

81 Before every function prototype in ``.h`` files, include a Doxygen-formatted comment
144 Doxygen Comment Specifics
146 Doxygen is the first program in a chain that generates the online LVGL API
147 documentation from the files in the LVGL repository.  Doxygen detects files it should
148 pay attention to by them having a ``@file`` command inside a Doxygen comment.  Doxygen
153 illustrating most of the Doxygen commands used in LVGL.
184 - Always start Doxygen comment with a brief description of the code element it documents.
188   for calling the function.  Doxygen needs the blank line to separate "brief" from
200 - Add at least 2 spaces after Doxygen commands for improved readability.
203   names and function names, Doxygen generates a hyperlink to that code member's
206 - Append empty "()" to function names.  Doxygen will not generate a hyperlink to the
218   Doxygen doesn't need the ``{.c}`` part, but the downstream software does.
220 - Refer reader to additional information using the ``@see`` command.  Doxygen adds a
224   a Doxygen comment like this is at the top of each new file.  Doxygen will not parse
235 Supported Doxygen Commands
238    tells Doxygen to parse this file and also supplies documentation about
242    follows it until Doxygen encounters a blank line or another Doxygen command.
244    documents the return value until Doxygen encounters a blank line or another Doxygen command.
246    surrounds code that should be placed in a code block.  While Doxygen knows to use C
252    the end of the comment, or another Doxygen command that starts a new section.
255    add additional paragraphs to notes as indicated in the Doxygen documentation.