Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I am looking for a plugin(s) for VS2010 that will allow me to:
Document my code easily.
Browse that documentation.
Export it into some format or other.
I was looking for a sort of front-end for doxygen + a documentation browser, but found nothing. Any other such tool will be great, it doesn't have to be doxygen, although it should preferably be free.
Thanks
My addin, Atomineer Pro Documentation, will help you a lot with generating and updating documentation comments. It will save a huge amount of time creating the comments as it not only provides boilerplate commetns, but also fills in as much documenation as it can to help minimise the typing you need to do to complete the docs. It makes it extremely easy to keep the docs in sync with the code. It supports comments in Documentation Xml and Doxygen (Qt or JavaDoc) formats, and the style and layout of comments is highly configurable. It handles C++, C, C++/CLI, C#, Java, and Visual Basic.
You can then process the documentation comments using Doxygen (which also handles DocXml, Qt, JavaDoc formats) to produce external (e.g. html) documentation.
JavaDoc/Qt format comments can be made more readable than XmlDoc, but it's worth considering that Visual Studio supports XmlDoc (so you get syntax colouring in the comments, code analysis tools like FxCop and StyleCop can check the content for you, and in some languages the intellisense system can show your documentaton in tooltips as you write client code, etc. So XmlDoc is steadily gaining a lead over the other documentation formats due to the VS IDE support for it).
Why don't you just use the official Doxygen GUI? The documentation is usually generated within seconds and it can generate very nice HTML files.
Related
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
What's an advisable way of documenting and sharing APIs (e.g. HTTP web-services)?
The requirements are:
A Wiki type system in which anyone can edit any page.
An easy way to write an API spec so that the styling/formatting is applied automatically, rather than having to manually add the styling for each individual page.
I would use Wordpress, except that it's not really a Wiki system; it's more of a blog engine. I want a nice, clean, structured hierarchy of pages, and the ability to click and edit instantly.
I tried Google Sites, but this also seems to be unsuitable, because it doesn't allow me to create a consistent style for APIs. The only control I have over styling is "themes", which change the look & feel of the whole site, and aren't specific enough.
I found a hosted solution here, but at $499 p/year I'm sure we can do better.
Any suggestions?
Many projects use trac. Here is an example of a project that uses it http://djangobb.org/wiki
Trac integrates together wiki, issue tracking and source control.
Might consider using something like doxygen to generate an inital snapshot and then just wikify that.
A similar question was posted here also: Wiki solution for APIs documentations?
and I suggested using MindTouch
**jonathan, just saw your comment about trac adding too much complexity. you'll likely find the same with MindTouch, but that's because you're asking for a solution to a specific problem, and the suitable tools available offer much more capabilities (ie complexities)
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I am using Visual Studio and an external library that is commented in doxygen-style. Is there any way to display doxygen documentation in the editor tooltip like DocXML?
The VS plugin Visual Assist shows doxygen comments. From what I can see, it doesn't actually process them, but it shows doxygen comments (in their raw form) nevertheless.
There's a trial at their website.
Be warned, though. I have seen very few C++ programmers who tried it for a few days and were not begging their managers to buy it for them afterwards.
Not that I am aware of (though I'd love to hear if there is a solution, as doxygen format is much more readable than XML).
A "workaround" I can suggest is that my AtomineerUtils add-in can bulk-convert Doxygen format comments into DocXML, which is then picked up and used for Intellisense tooltips. (And Doxygen is able to read DocXml, so you keep most of that functionality too). Currently the conversion is a fairly simple one, but I'm working on some improvements at the moment that should make it much more flexible with respect to input comment formats.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 8 years ago.
Improve this question
Are there any good free C/C++ libraries that enable reading from common devices with filesystems such as UDF, and ISO9660 and extracting files/metadata etc.?
So far all I've been able to find is GNUs libcdio which is promising, and some "Magic UDF" which has so many hits I'm disgusted, pushes other results in Google, and comes with a pretty extreme looking price tag.
Cross-platform support is preferable (personal preference of course), and Windows compatibility is an unfortunate requirement. The less restrictive the license, the better, I have yet to investigate how compatible libcdio's GPLv3 license is.
Note this question is still open, I'll accept another answer if someone locates such a library.
After extensive investigation, I ended up rolling my own solution to perform the operations on UDF that I required. I'm unable to open the source, in all it was about 800 lines of C++. However here are several links which got me through:
The reference standard on which UDF is built
Universal Disk Format specification 2.60
Brief introduction to UDF
Wikipedia Page
UDF Verifier tool (you must sign up for access to this)
A few words of warning: Previous experience implementing ISO9660/ECMA-119 helped me significantly. Knowledge of how block devices operate and interface with the operating system is helpful. Information surrounding the physical layout and separation of sessions is somewhat mythical and difficult to grok.
See: http://www.thefreecountry.com/sourcecode/cpp.shtml
There are a lot of open source library for this but reliability is question.
On Windows You can use Image Mastering API. It comes with Window SDK , Work on both XP & Vista
http://msdn.microsoft.com/en-us/library/aa364806%28VS.85%29.aspx
7-Zip supports extracting files from UDF and ISO disk images, and is mostly LGPL licensed. Specifically, the UDF implementation code appears to be in CPP/7zip/Archive/Udf/UdfIn.cpp.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 7 years ago.
Improve this question
I have a large 95% C, 5% C++ Win32 code base that I am trying to grok.
What modern tools are available for generating call-graph diagrams for C or C++ projects?
Have you tried doxygen and codeviz ?
Doxygen is normally used as a documentation tool, but it can generate call graphs for you with the CALL_GRAPH/CALLER_GRAPH options turned on.
Wikipedia lists a bunch of other options that you can try.
Have you tried SourceInsight's call graph feature?
http://www.sourceinsight.com/docs35/ae1144092.htm
Good old cflow works fine for C. See here for an implementation.
Any decent static analysis tool should have this functionality (as well as all the other stuff that such tools do). Wikipedia has a good list of such tools.
Another group of tools that may be worth checking out are coverage tools. The call graph generated by the coverage tool will contain only the calls that actually take place during a run of the program. Initially this may be more helpful to you than a full call graph. I'm unable to make any suggestions on this for Windows, but for linux projects I highly recommend gcov and lcov.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I have several projects, some using managed code and some using only unmanaged. All have the XML comments have been added and the XML documentation is being generated correctly (the generated xml file and intermediate the xdc files).
Surely there's something that can take these files (the output of xdcmake) and generate MSDN style chm help! ?
From what I understand, both doxygen and sandcastle ignore that obvious step and re-invent the wheel to re-scan your code. (there's also the fact that sandcastle is apparently useless for non-.NET projects).
Having tried doxygen (horrible output, but fast) and sandcastle (nice MSDN style output, but sloooooow) both are begging to be outdone by something much simpler.
It would also be nice if there was some kind of editor associated that we can also write the 'Getting Started' and 'Information' kind of pages that are also needed with any API documentation.
Does anyone know of any solutions?
You might want to try DoxyComment. Here is the description from Doxygen's Helper tools & scripts:
An addin for Visual Studio 2005 called
DoxyComment was created by Troels
Gram. It is designed to assist you in
inserting context sensitive comment
blocks into C/C++ source files.
DoxyComment also comes with an xslt
template that lets you generate
documentation like the MSDN library.
Honestly, Sandcastle is your best bet. I know it can be a bit of a pain to configure, but the documentation is exactly the style you are looking for.
I know the project where people still use NDocConsole
However I suppose that NDoc is a dead project, because on http://ndoc.sourceforge.net/ there are no updates since 2005