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.
Related
This is possible a duplicate, notheless old questions might be outdated.
I know the basic logging principles of Qt, using qDebug() << "error"
and I know that with Qt 5.2 categories where introduced (example found here: https://evileg.com/en/post/154/)
But I do not see that Qt provides a framework ready to use.
I would like to have a file write based logger, thread save, that is compatible with log4net (or log4j). Even if not with the output of log4net it should be stable and proven to work.
I found log4qt
https://sourceforge.net/projects/log4qt/ But the source does not even include a make file or anything to make it. Also the code is from 2009 and very likely outdated.
I also found the log4cxx, but that is based on Linux compile tools and I could not find out how to make it using ming32 on windows. Since I dislike to invest hours to even compile a framework I rather not want to use this framework.
Is there anything more modern, up to date for Qt, usable on windows?
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!
The clang C++ compiler claims to be built for, among other things, better IDE integration by providing an API for the IDE to use for tasks such as parsing the code.
So, are there are any good C++ IDE's that use clang to provide features such as semantic highlighting, refactoring, and finding and showing semantic errors in real-time?
I've been using Eclipse CDT, but its C++ parser is full of imperfections that cause the IDE to report a lot of annoying false positive errors in the code. I would like to have an IDE that reports an error if and only if the compiler would report the same error, hence my interest in an IDE that's built on a compiler's internals.
I'm primarily interested in cross-platform IDE's, although I wouldn't mind knowing about single-platform ones for Windows or Linux (so not Xcode), as long as they are FOSS (another reason why not Xcode).
Qt Creator is basing their next-gen code parsing and associated functionality on Clang:
https://www.qt.io/blog/2011/10/19/qt-creator-and-clang
Looks very, very promising!
have you tried clang complete?
if you're punk rock, then vim is enough ide ;)
i often work with xcode so... can't really share firsthand experience, but i knew of its existence.
gedit isn't really an IDE, but there is a plugin for it that provides code assistance using clang
It seems that CodeLite v3.5 starts supports Clang natively. However I haven't found is it possible to setup LLVM as backend.
A relevant new development in this area in the Language Server Protocol (LSP) project, which aims to be a language-agnostic API that allows editors / IDEs to be decoupled from backends that provide code intelligence / analysis.
There is ongoing work to create a clang-based C++ backend called Clangd.
There is also ongoing work on several editors / IDEs to support the LSP as a client.
Once the backend implementation matures, all editors supporting the LSP will, in principle, be able to leverage clang's capabilities as exposed through Clangd.
KDevelop now has clang based c and c++ support, including semantic analysis and autocomplete. It is primarily for linux but (as of October 2016) has a beta release out for windows and mac as well.
For emacs there are irony-mode and rtags that provide features such as auto-complete, on fly error checking and jump to symbol. When combined with cmake-ide they are very powerful tools and one well versed in emacs can be highly productive in this environment.
Not FOSS, but JetBrains (of IDEA and ReSharper fame) are building out their AppCode product into a full C++ IDE supporting Win/Linux/Mac and using clang.
Yes, really.
jucipp
~900 stars on GitHub in 2019Q2: https://github.com/cppit/jucipp
Now moved to GitLab: https://gitlab.com/cppit/jucipp
Clearly advertises libclang backend as a main feature.
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 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.