Creating and Viewing Doxygen Documentation
In this section:
- Viewing Doxygen Documentation
- Creating Doxygen Comment from Scratch
- Reliable Rename
- Doxygen Typing Assistance
Doxygen-style comments can be placed across the source code and used for generating full-fledged documentation in various formats. In case you have a project documented this way, you can easily run Doxygen tool from the built-in terminal in AppCode to get the documentation. Besides, AppCode allows you getting more value out of Doxygen comments inside the IDE itself.
AppCode includes the information from Doxygen-styled comments into the Quick Documentation pop-up:
Viewing Doxygen Documentation
Doxygen-styled information is included in Quick Documentation pop-up in addition to the type information. To invoke the documentation pop-up, do the following:
Place the caret at the desired symbol or at the
@paramcommand of the Doxygen comment.
- Press F1.
If function parameters are documented separately from the function description, AppCode will merge all the comments and show you the full function’s signature documentation.
Creating Doxygen Comment from Scratch
To create a Doxygen comment for a function from scratch, do the following:
Type each of the following symbols:
/*!at your choice, followed by ⏎.
- Fill a stub that is created with the required documentation text.
While changing a function name or its parameters names, you definitely need Doxygen comments updated accordingly. AppCode does that for you in case you are using Rename refactoring:
Doxygen Typing Assistance
Basic typing assistance for Doxygen commands is provisioned by AppCode auto-complete feature. Note, that not all commands are available in the completion. The recent list of the commands that are not supported for the moment can be found here.