* \brief This description shows up at the top of the doxygen so you don't have to scroll. Here is an example geared toward a class that is likely compiled into a library: The \htmlinclude line inputs a nicely formatted version of the package's manifest.xml file.ĭoxygen's main strength is that you can include documentation inline with your code. NOTE: you have to use C comment syntax in this file, e.g., : Also, if you use the roscreate-pkg tool to create your package, a mainpage.dox will be generated for you. To make things easier, we have created a default template in the rosdoc package, which you can find at rosdoc/templates/. There should only be one mainpage tag in your package, so we usually recommend creating a top-level file, e.g. The first thing you'll probably want to do is use the \mainpage tag. You can use any Doxygen markup in your code. For actual documentation on how to use the Doxygen documentation tool, please see the official Doxygen site. NOTE: this page is not a comprehensive guide to Doxygen. For Python we generally use Epydoc or Sphinx. With ROS packages, we generally use Doxygen to document C -based code. Instead, we recommend that you use the rosdoc_lite tool, which provides common templating and other features. You don't need to configure and run Doxygen manually in order to generate documentation for your ROS package. Doxygen searches for source code in your tree and generates API documentation for it. The main advantage of Doxygen is that you can write documentation directly within the comments of your source code. To hide the Rendered View gutter icons, select Configure Gutter Icons from the context menu in the gutter and then clear the Documentation comments in-place rendering checkbox on the Settings/Preferences | Editor | General | Gutter Icons page that opens.Doxygen is a tool for auto-generating API documentation, though you can also use it to generate documentation separate from an API. To show all Doxygen comments rendered by default, open the Settings/Preferences dialog ( Ctrl Alt S), go to Editor | General | Appearance, and select the Render documentation comments checkbox. If necessary, select Adjust Font Size from the context menu and change the font size using the slider. To turn on the Rendered View mode for all Doxygen comments in the current file, select Render All Doc Comments from the context menu in the gutter. To quit the Rendered View mode, click in the gutter, or select Toggle Rendered View from the context menu of a Doxygen comment, or press Ctrl Alt Q. To enter the Rendered View mode, hover the mouse pointer over a comment and click in the gutter or press Ctrl Alt Q. Opening the referenced web pages is not available.ĮOL block comments are rendered only if they start the line. In this Rendered View mode, items are shown grouped by their tags, while the tags themselves are skipped. With CLion, Doxygen comments can be shown in an easier-to-read format. Here you can find the list of the commands that are currently unsupported. Note that not all the commands are available in the completion. In case of the Rename refactoring Shift F6, CLion updates Doxygen comments along with other references.īasic typing assistance for Doxygen commands is provisioned by CLion auto-complete feature: While renaming a function or its parameters, the Doxygen comments need to be updated accordingly. You will get a stub to fill with the documentation text: Type one of the following symbols: ///, //!, /** or /*! and press Enter. To create a Doxygen comment from scratch: If function parameters are documented separately from the function description, CLion will merge all the comments and show you the full function’s signature documentation (the same way as Doxygen does when generating the output) : Creating comments from scratch Place the caret at the desired symbol or at the command of the Doxygen comment.Īlternatively, when the checkbox Show quick documentation on hover ( CLion | Settings/Preferences | Editor | General | Other) is selected, just move your mouse pointer over the desired symbol. Besides, CLion enables you to get more value out of the Doxygen comments inside the IDE itself.ĬLion includes the information from the Doxygen-styled comments into the Quick Documentation popup Ctrl Q: Viewing documentationĭoxygen-styled information is included in Quick Documentation popup in addition to the type information. In case you have a project documented this way, you can easily run Doxygen tool from the built-in terminal in CLion to get the documentation. Doxygen-style comments can be placed across the source code and used for generating full-fledged documentation in various formats.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |