Difference between revisions of "DoxyBlocks plugin"

From CodeBlocks
Jump to: navigation, search
(Described toolbar.)
m (Formatting.)
 
Line 17: Line 17:
  
 
; [[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''
 
; [[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">
+
<source lang="cpp" enclose="div">
 
/** \brief  
 
/** \brief  
 
  *
 
  *
Line 31: Line 31:
  
 
; [[File:Comment line.png]] : Insert a line comment at the current cursor position. ''Ctrl-Alt-L''
 
; [[File:Comment line.png]] : Insert a line comment at the current cursor position. ''Ctrl-Alt-L''
<source lang="cpp">  
+
<source lang="cpp" enclose="div">
 
void MyClass::Foo(bool bar)
 
void MyClass::Foo(bool bar)
 
{
 
{

Latest revision as of 02:02, 20 March 2012

DoxyBlocks
DoxyBlocks.png
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:

Doxywizard.png 
Run doxywizard. Ctrl-Alt-D
Extract.png 
Extract documentation for the current project. Ctrl-Alt-E
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
/** \brief
 *
 * \param bar bool
 * \return void
 *
 */
   
void MyClass::Foo(bool bar)
{
    fooBar(bar);
}
Comment line.png 
Insert a line comment at the current cursor position. Ctrl-Alt-L
void MyClass::Foo(bool bar)
{
    fooBar(bar); /**<  */
}
Html.png 
View generated HTML documentation. Ctrl-Alt-H
Chm.png 
View generated HTML Help documentation. Ctrl-Alt-C
Configure.png 
Open DoxyBlocks' preferences. Ctrl-Alt-P