Doxygen / Kings Tools for VS 2005?
-
Hi guys, I'm trying to download an add-in to MS VS 2005 that enables one to have auto-generated method-documentation etc. above methods like this: /** void foo() { } becomes something like: /* * /pre * /post * /arg1...n * /comment * void foo() { } Then afterwards one can generate the documentation fron this by running some tool inside VS - I don't remember details 100% because I have'nt used it since VS 6.0. How do I do? Naturally I've been across the Doxygen article on CP but it talks about VS 2003 (I think) - is it on http://msdn2.microsoft.com/en-us/visualc/default.aspx[^]? I don't care if it generates chm-files or html.
Regards, Michael Mogensen, mm it-consult dk. ><((((º> ·.¸¸.· ><((((º> ·.¸¸.· ><((((º>
-
Hi guys, I'm trying to download an add-in to MS VS 2005 that enables one to have auto-generated method-documentation etc. above methods like this: /** void foo() { } becomes something like: /* * /pre * /post * /arg1...n * /comment * void foo() { } Then afterwards one can generate the documentation fron this by running some tool inside VS - I don't remember details 100% because I have'nt used it since VS 6.0. How do I do? Naturally I've been across the Doxygen article on CP but it talks about VS 2003 (I think) - is it on http://msdn2.microsoft.com/en-us/visualc/default.aspx[^]? I don't care if it generates chm-files or html.
Regards, Michael Mogensen, mm it-consult dk. ><((((º> ·.¸¸.· ><((((º> ·.¸¸.· ><((((º>
Doxygen works with VS2005, too. My setup is roughly: A "Tools" command that runs the doxygen compiler, passing the docs.doxygen in the current solution folder. You can make a button for that. e.g.
Title: Run Doxygen command: C:\Program files\doxygen\bin\doxygen.exe Arguments: $(SolutionDir)\docs\docs.doxygen Initial Dir: $(SolutionDir)You might prefer to set this up for the current project (rather than solution). You could also do that as a custom build step on the docs.doxygen file (I don't like that because the output litters the compile, and takes a bit of extra time). Another "tools" command that runs doxywizard on the same doxygen file. The docs.doxygen and resulting .chm is adeed to the project, so I can double click them for viewing / quick editing. The method documentation skeleton can be done through CodeWiz2 addin, or through Visual Assist (refactor/document method, you can set up the related autotext to make it fit for doxygen). I'm using VA for that. Both CodeWiz and VA require 8re-)moving the types from the \param sttatements, but that doesn't bother me. It's not to elegant, but works for me.
Kings Tools: Tried this a while ago, wasn't my cup of tea - I can't remember what I disliekd though.
Sandcastle is a documentation generator for the XML documentation natively supported by VS 2005. In this case, VS2005 will generate the method declaration (I think, at least it does for C#, never tried XML comments in VC).
Developers, Developers, Developers, Developers, Developers, Developers, Velopers, Develprs, Developers!
We are a big screwed up dysfunctional psychotic happy family - some more screwed up, others more happy, but everybody's psychotic joint venture definition of CP
Linkify!|Fold With Us! -
Hi guys, I'm trying to download an add-in to MS VS 2005 that enables one to have auto-generated method-documentation etc. above methods like this: /** void foo() { } becomes something like: /* * /pre * /post * /arg1...n * /comment * void foo() { } Then afterwards one can generate the documentation fron this by running some tool inside VS - I don't remember details 100% because I have'nt used it since VS 6.0. How do I do? Naturally I've been across the Doxygen article on CP but it talks about VS 2003 (I think) - is it on http://msdn2.microsoft.com/en-us/visualc/default.aspx[^]? I don't care if it generates chm-files or html.
Regards, Michael Mogensen, mm it-consult dk. ><((((º> ·.¸¸.· ><((((º> ·.¸¸.· ><((((º>
Theres also the option of the built in XML documentation[^] stuff. That will provide the tips that appear with intellisense. You can then compile the XML documentation into a help file using Sandcastle[^] from MS which is a command line app. GUIs[^] are avalible from the community.