Welcome to the atom-doxit package website

Overview

This is a very simple package to insert Doxygen comment templates, using the packages menu or a keyboard shortcut. Two types of comment can be inserted at the current cursor position:

• file header comment: Contains file information (author, copyright, description, etc.)
• function description comment: Contains basic details to describe the function. Fields are automatically completed where possible (dates, author name).

Customisation

The author name must be configured in the package settings, otherwise the package will insert the default Joe Bloggs. The keyboard shortcuts are configurable. Not much thought has gone into the default keyboards shortcuts, so it is recommended that these are set based on personal preference.

Authors and Contributors

This package was originally created by Cameron A. Craig (@camieac). Additional contributors will be added here as necessary (any help to improve the package is greatly appreciated).

Support or Contact

If you are having difficulty with the package, a Github Issue is likely to be the best solution. I can be contacted by email also. My email address should be visible on my profile page.