1-Click Docs

Introduction

A lightweight extension that integrates the popular Doxygen documentation generation program into Visual Studio, providing the following functionality:

• Format Doxygen-recognised comments differently from other source code comments
• Automatically save open documents before launching Doxygen
• Easily run Doxygen on the whole solution, a single project or subfolder, or even a single file.
• Automatically navigate from the editor window to the Doxygen-generated documentation for the highlighted code element.

Getting Started

Having installed 1-Click Docs, look for the 1-Click Docs option on the Tools menu and then open the User Manual for more detailed information on how to use it. Any questions can be submitted through the Q&A link above.

Doxygen Compatibility

Doxygen must be installed separately. 1-Click Docs is only loosely dependent on Doxygen (specifically the format of the Doxygen configuration file, and, if navigating to generated documentation, the format of the Doxygen tag file). These are very stable aspects of Doxygen, meaning that this extension is compatible with most versions of Doxygen. It has been tested with Doxygen versions 1.8.1-1.8.13.

Releases

v1.1.0: Dropping support for VS2013. Setting the Doxygen executable path from the browse button updates the correct path in the dialog box.

v1.0.9: Further code restructure to allow separate build targeting VS2013

v1.0.8: Added ability to highlight recognised Doxygen commands

v1.0.7: Code restructure to allow for build targeting VS2022

v1.0.6: Added a more helpful error message if Doxygen executables cannot be found.

v1.0.5: Removed a fixed dependency on VCCodeModel which is only installed if Visual Studio is set up with the C++ workload.

v1.0.4: Updated code to provide correct functionality in languages other than English.

v1.0.3: Fixed a bug that appeared in some installations of Visual Studio 2017 and Visual Studio 2019, meaning that some types of doxygen comments would not be formatted correctly.

v1.0.2: Updated Manifest so Visual Studio 2019 is supported.

v1.0.1: Minor bug fix that caused a failure to load. See Release Notes for more details.