I've been reading up on Doxygen online, and I think I'd like to try it out on my Netbeans C++ projects. The problem is, I cannot find any tutorials/guides anywhere to how to get Doxygen working with Netbeans. I've found some blog posts that seem to be about using Doxygen in Netbeans, but they seem semi-feature requesty, and I cannot tell if they are actual guides or just "this is what it should look like when it is done" posts. So, does anyone here have any experience of working with Doxygen and Netbeans?
There is no need for support from IDE to use Doxygen, you can use them separately. To create Doxygen documentation you just need a source code and Doxygen compiler.
However IDE can serve some kind of support. Netbeans allows you quickly create a comment (see here). That's the only support I know.
There is also plug-in "Doxygen Integration" but I never used it.
Related
It seems Eclipse has Doxygen support somewhat natively now. Go to C/C++ -> Editors -> Documentation Tool Comments: Doxygen.
However it appears to only act on /** */ comments for auto generating.
In our project we use triple slash /// to generate doxygen comments.
It seems there is no way to configure Doxygen comment generation in Eclipse. Any tips? Is there a config file we can alter? Some way to force it.
Unfortunately as of posting this answer there is no solution. The doxygen comment style is apparently hard coded in Eclipse Juno and previous. You can see a bug report here: https://bugs.eclipse.org/bugs/show_bug.cgi?id=333134
There are workarounds but none support the auto doxygen comments generated in eclipse by merely typing '///[enter]'. See here for some attempts: Change doxygen comment style in Eclipse
A C++ code template is a good attempt but leaves a lot to be desired.
Until this changes this is the accepted answer.
Old question but it's better to add a fresh answer, currently eclipse cdt 9.10 in 2019-12 fully support /// and //! styles, in 2020-03 has been added few options to customize doxygen behavior
I've been working on some C++ code that some of the other developers I work with will use. A lot of the developers here are MS based (they use Visual Studio as their main IDE) we also have a lot of developers who use other IDE's as well for different projects (like Eclipse and Qt, even some C++ Mac development with XCode).
The code I have are generic library functions that are cross platform compatible, so it will be used by different developers on different platforms/IDE's. Which brings me to my question: is there a compatible Doxygen comment 'style' that can be 'understood' and used with the code completion ability by most popular IDE's (VS, Eclipse, Qt, Netbeans, XCode)?
Something like VS's IntelliSence where when you use your scope resultion a description pops up for that item.
If there is not a 'compatible' way, are there any plugins that can be used for all IDE's that would allow for this ability, or would I have to write my own? Googling has lead me to many dead ends (possibly because I may not be inputing my question into correct search terms), and writing my own plugins is an option, though I'd prefer a 'compatible' style or existing plugin if possible to save time.
Thanks in advance!
Edit 1: I should mention that I am requesting Doxygen style commenting becuase it is the documenting tool we use to build out some of our documentation thus all comments in any code we make must be Doxygen style (not sure why this issue never came up before here, haha)
So I have been struggling with this question for awhile now. In the past I have used several different software suites for development, with each having its own quirks in regards to using the documentation to drive some of the more fancy features. After working on a project in C# (and Visual Studio 2010) I have come to realize that the XML commenting seems to work the best for me.
I personally believe that this is a failure in most of the IDE applications themselves, for example, it seems that Visual Studio really only supports XML commenting for C# applications to feed features such as Intellisense, and the less fancy syntax highlighting. I have found that there is a commercial plugin available to "enable" this feature in Visual Studio, but why should I pay for something that just has not been enabled?
But I have diverged from your original question. When I was first researching this it seemed that Apple themselves must use Doxygen as they seem to use this standard for highlighting code already. With that said, here are some other resources to get the same functionality in other applications:
Atomineer Pro Documentation seems to be the tool for the job in regards to Visual Studio although I have not personally used it. It seems relatively simple to use.
Eclox seems to be a front-end plugin for Eclipse that actually uses Doxygen. But from what I remember you should be able to tweak the IDE itself in the C++ settings in regards to syntax highlighting.
Doxymacs maintains a symbol table inside of Emacs for some quick searching abilities.
It seems that on the Vim project page there's a script that handles this for that editor as well, it is called DoxygenToolkit.
I absolutely feel your pain. There's something warm and toasty about having a nightly crontab generate cleanly documented markup that is easily searchable. I have only recently been on a warpath for finding the best mechanism available for achieving this cross-platform. From what I've gathered most development environments support extensions of sorts, and since Doxygen is basically the "gold standard" there's usually one way or another to shoehorn support in if it doesn't exist out of the box.
If you're interested Doxygen actually supports the C# XML comments out of the box, but unfortunately I wasn't able to get it working in Xcode, and I'm not well versed enough in AppleScript to hack it together. But by all means please update if you do!
I've been annoyed lately by the fact that PyDev doesn't information about classes and function when it code completes wxPython code.
Can anybody tell me FOSS IDE's or extensions that offer code information (function params, returns etc.) when it code completes for C/C++ and Python.
I am a fan of CodeLite, Eclipse CDT and CodeBlocks in that order for C/C++ (excepting non-FOSS)
and PyScripter, PyDev for Python in that order.
Vim + Exuberant Ctags
See here, here and here for C++ autocompletion (also referred to as IntelliSense, taken from the name for Visual Studio's autocomplete).
And here for Python autocomplete/"intellisense" for vim. (I should point out I found the link to that from this post on SO).
If that doesn't include the ctags for wxPython as you require, you might want to check out this guy's ctags-based highlighting which apparently does work for wxPython (and perhaps take the ctags file from that?)
Probably also worth checking out this enormous list of Python IDEs on SO (specifically those with "AC" tags) if you've not already seen that? I realise your question is a bit more specific than just basic Auto Complete, but perhaps there's some new options in there for you...
I use notepad++ and am vary happy with it.
i found this autocompletion for Emacs: http://www.emacswiki.org/emacs/AutoComplete, but I can't find what languages it supports.
I want to use it particular for C++-autocompletion. Has anybody experience with this?
As you can see from the User's Guide it has built-in support for C/C++ by means of Semantic. There is also one more tool from the auto-complete mode developer called GCC Sense, which he claims to be most intelligent tool for C/C++ programming and of course it integrates nicely with auto-complete so you might have a look at it as well.
Setup of Emacs with CEDET for autocompletion for C++ is described in my article. You can look to my CEDET config for working setup
I've recently began using C++ with XCode and I'm starting to miss the integrated documentation that is available for Objective-C. I know that there is a way to generate documentation sets using Doxygen, but a readily available bundle would certainly be preferable...
Is there an easy way to get XCode to search at least the standard C++ library documentation?
Using Doxygen is probably the easiest. The docs are quite straighforward and simple. Did you give it a shot?
In looking at the other docs it looks like it should be there already. I was surprised it wasn't.