Difference between revisions of "DoxyBlocks plugin"
From Code::Blocks
(Described toolbar.) |
|||
| Line 9: | Line 9: | ||
'''DoxyBlocks''' is a plugin for Code::Blocks that integrates [http://www.stack.nl/~dimitri/doxygen/index.html doxygen] into the IDE. It allows you to create documentation, insert comment blocks and run HTML or CHM documents. It also provides configuration of some of the more commonly used settings and access to doxywizard for more detailed configuration. | '''DoxyBlocks''' is a plugin for Code::Blocks that integrates [http://www.stack.nl/~dimitri/doxygen/index.html doxygen] into the IDE. It allows you to create documentation, insert comment blocks and run HTML or CHM documents. It also provides configuration of some of the more commonly used settings and access to doxywizard for more detailed configuration. | ||
| + | |||
| + | The settings in the DoxyBlocks toolbar have the following meanings: | ||
| + | |||
| + | ; [[File:Doxywizard.png]] : Run doxywizard. ''Ctrl-Alt-D'' | ||
| + | |||
| + | ; [[File:Extract.png]] : Extract documentation for the current project. ''Ctrl-Alt-E'' | ||
| + | |||
| + | ; [[File:Comment block.png]] : Insert a comment block at the current line. Additionally, DoxyBlocks will try to intelligently read if a method exists on the line for which a comment is being added. ''Ctrl-Alt-B'' | ||
| + | <source lang="cpp"> | ||
| + | /** \brief | ||
| + | * | ||
| + | * \param bar bool | ||
| + | * \return void | ||
| + | * | ||
| + | */ | ||
| + | void MyClass::Foo(bool bar) | ||
| + | { | ||
| + | fooBar(bar); | ||
| + | } | ||
| + | </source> | ||
| + | |||
| + | ; [[File:Comment line.png]] : Insert a line comment at the current cursor position. ''Ctrl-Alt-L'' | ||
| + | <source lang="cpp"> | ||
| + | void MyClass::Foo(bool bar) | ||
| + | { | ||
| + | fooBar(bar); /**< */ | ||
| + | } | ||
| + | </source> | ||
| + | |||
| + | ; [[File:Html.png]] : View generated HTML documentation. ''Ctrl-Alt-H'' | ||
| + | |||
| + | ; [[File:Chm.png]] : View generated HTML Help documentation. ''Ctrl-Alt-C'' | ||
| + | |||
| + | ; [[File:Configure.png]] : Open DoxyBlocks' preferences. ''Ctrl-Alt-P'' | ||
Revision as of 22:48, 6 March 2012
DoxyBlocks
| Developer(s): | Gary Harris |
| Maintainer(s): | |
| Version: | 1.7.658 |
DoxyBlocks is a plugin for Code::Blocks that integrates doxygen into the IDE. It allows you to create documentation, insert comment blocks and run HTML or CHM documents. It also provides configuration of some of the more commonly used settings and access to doxywizard for more detailed configuration.
The settings in the DoxyBlocks toolbar have the following meanings:
- Run doxywizard. Ctrl-Alt-D
- Extract documentation for the current project. Ctrl-Alt-E
- Insert a comment block at the current line. Additionally, DoxyBlocks will try to intelligently read if a method exists on the line for which a comment is being added. Ctrl-Alt-B
/** \brief
*
* \param bar bool
* \return void
*
*/
void MyClass::Foo(bool bar)
{
fooBar(bar);
}
- Insert a line comment at the current cursor position. Ctrl-Alt-L
void MyClass::Foo(bool bar)
{
fooBar(bar); /**< */
}
- View generated HTML documentation. Ctrl-Alt-H
- View generated HTML Help documentation. Ctrl-Alt-C
- Open DoxyBlocks' preferences. Ctrl-Alt-P
