Main Page  



DoxBar is an add-in for using doxygen from within Developer Studio. The add-in has three functions:


Copyright © 2000-2002 by Dimitri van Heesch.

Permission to use, copy, modify, and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. See the GNU General Public License for more details.


The latest release of the add-in can be downloaded in source or binary form from the doxbar project page on sourceforge. Development sources can be obtained from the CVS repository using doxbar as the module name. This add-in has been tested under Windows XP Home edition and might not work under other windows platforms.


To be able to use or compile the add-in, you need the following:


Do the following to install the tool:

A configuration menu like the following should appear:

Running doxygen

To run doxygen on a project do the following:

Using the HELP feature

To start an external help file (for instance one that was generated with doxygen :-) do the following once:

you see the current selected item (initially CustomHelp1). The current item is the one that will be executed by pressed the "Search" button of the add-in ()

After that you can just press the "Search" button to lookup the selection or a word in the index of the help file.

You may wonder why there is more than one help option while there is only one help button.
This is because all help options are available to developer studio. You can assign a key to any of them, by selecting "Customize..." from the Tools menu. Select the "Keyboard" and Category "Add-ins":


Using the Auto Comment feature

Position the caret on the line you want to be automatically commented and simply press the Auto Comment button (). Doxbar will analyse the line and will recognize class, function and typedef declarations. If none of these three are recognized, a default comment will be added.

In the doxbar and project options, you can indicate a path to comment templates. If you leave these fields blank, the running directory will be used. The used path will be searched for the following files:

These files should contain C++ comments with special tags that will follow these rules:
Moreover, in all templates, in every possible line, the following tag will be recognized
Where DateFormat is a valid format to pass to the strftime() standard function. Please see at this website for details: MSDN strftime() page

If one or more of these files is missing, the default templates will be used

Changing the settings of the project

Doxbar will generate a configuration file based on the template you indicated during setup, or the one generated by doxbar. If you want to alter the settings of this template click on the template button (). The following dialog will show up:


If you leave your mouse long enough on a entry zone, you will get, as on the picture, a tool tip message explaining what is the function of the zone. This only works if the template doxyfile contains comments. This is why you should let doxbar create a basic template and copy it in your project's directory.
All the tabs in this dialog are generated from the template file except the 'Doxbar specific' tab. This one contains project dependent options, specific to doxbar and changing the values of these options will not affect directly the way doxygen generates the documentation.
You can choose how doxbar explores the projects collection in the current workspace. Selecting 'the active project and its dependencies' requires that the workspace file (.dsw) is named the same as the active project file (.dsp). A warning will be issued if this is not the case.
You can also choose to force HTML and HTML Help outputs. It is recommanded to check those two options to get full use of doxbar.
Please note that the template changes are made on the project's doxyfile, not on the default template. Moreover, the doxbar specific settings are stored in a file named after the project's name but with the .dox extension, created in the project's directory.

Viewing the error log file content

If you indicated a file name in the WARN_LOGFILE of the configuration file, you can use the log button () to display its content in the Macro tab of the Output window.
To allow a convenient navigation from the output window to the source it is necessary to set the profile entry WARN_FORMAT to '$file($line) : $text'
However, if you checked the Use Output Window check box during installation, this may not be really usefull as the generated output is already available in the Doxygen tab of the output window.


Special thanks go to:

SourceForge Logo

Generated on Fri Nov 21 21:06:21 2003 for Doxbar by doxygen1.2.18