Developer forums (C::B DEVELOPMENT STRICTLY!) > Plugins development

Doxygen plugin

(1/53) > >>

Cryogen:
 Hi Guys,

I'd like to announce a new doxygen integration plugin. I call it DoxyBlocks.

I've loved and used doxygen (http://www.stack.nl/~dimitri/doxygen/) for years. I've used Doxbar under VS and missed a similar tool for C::B. Recently, I found jomeggs' doxygen script (http://forums.codeblocks.org/index.php/topic,8213.0.html), which works well but is somewhat limited, and was inspired to create a full plugin to replace it. Since doxygen is the C::B documentation tool of choice, it seemed even more appropriate.

DoxyBlocks provides a toolbar for quick access to documentation commands. It currently provides functionality which creates a doxyfile and extracts the docs, based on jomeggs script but fairly heavily modified. The converted code includes some extensions and some "tidying up" and adds functionality. DoxyBlocks can also insert block and line comments and run doxywizard for more detailed modifications of the doxyfile. It looks like this:


and includes a configuration panel in the editor settings module. All comment types described in the doxygen docs are available.

I plan to add more functionality to allow configuration of the default settings that go into the doxyfile. It might also be useful to add the ability to insert other tag types manually and I plan to look into generating document blocks automatically. I have seen code around that does that. Other things are open for discussion.

The only thing I don't propose to do is write a full replacement for doxywizard. Doxywizard is more than capable and it seems futile to recreate the wheel. My intention is rather to provide reasonable default configuration with some common settings available and defer to doxywizard for the rest. For example, I'd like the user to be able to control things such as OUTPUT_LANGUAGE, EXTRACT_ALL, FULL_PATH_NAMES and ouput types.  With the right balance DoxyBlocks should be able to set things up for you most of the time and you should only need to use doxywizard for access to less common settings. At least that's my hope.

I'm still thinking about one or two things such as being able to enter a custom comment style to be used.

It is already quite usable and DoxyBlocks itself was documented using...DoxyBlocks. :-)

You can find the source by pointing SVN at: https://doxyblocks.svn.sourceforge.net/svnroot/doxyblocks.

The project page is at https://sourceforge.net/projects/doxyblocks/ and a cbplugin is available for download, too.

Thanks to jomeggs for the script and the inspiration.

Cheers,

  Gary.

JGM:
Whoa really cool this is a feature that was really needed by codeblocks, a tool that facilitates documenting the code, great candidate to be part of nightly builds  8).

Thanks for your work :)

Cryogen:

 Thanks, I appreciate that. I certainly hope it will be useful. I'm already finding it very helpful.

 :)

killerbot:
in case  this works well, might be interesting to add it to our contrib plug-ins section in our source tree, and provide it with the upcoming release :-)
I will test it out too.

Question : does it work under windows and linux ?
One thing that won't be able I think under linux is the creation of chm's.

codeur:
Hi Cryogen,
The ".cbplugin" you provide fails to load with my current version built from a recent svn (6113).
Unfortunately I have no time currently to attempt to rebuild it for the current version, as (by looking at your project) your installation looks quite different and the project options would require a fair bit of editing, but I thought I'd let you know.

Navigation

[0] Message Index

[#] Next page