summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorHO-COOH <42881734+HO-COOH@users.noreply.github.com>2021-04-14 12:50:20 -0500
committerGitHub <noreply@github.com>2021-04-14 19:50:20 +0200
commita9fb66b381f4de6878880adef60b778d5d2fc416 (patch)
tree2b114c0cdc2fdd7323e4aff3cac66e6cbd3d19c2 /README.md
parentc8c7918538dea9b84499ac73a7d8f430860d9f5a (diff)
downloaddoxdocgen-a9fb66b381f4de6878880adef60b778d5d2fc416.tar.gz
Doxygen command intellisense support (#211)
* Nicer setting descriptions * Initial support for doxygen command completion * Remove commented function * Initial support for doxygen command completion * Remove commented function * Fix multi-line doxygen indentation * Doxygen documentation -> markdown, add gif, update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 25 insertions, 17 deletions
diff --git a/README.md b/README.md
index b1e3248..4a023dc 100644
--- a/README.md
+++ b/README.md
@@ -9,23 +9,26 @@ This VS Code Extensions provides Doxygen Documentation generation on the fly by
## Table of Contents
-* [Features](#features)
- * [Alignment](#alignment)
- * [Attributes](#attributes)
- * [Con- and Destructors](#con--and-destructors)
- * [Extensive customization](#extensive-customization)
- * [File descriptions](#file-descriptions)
- * [Function pointers](#function-pointers)
- * [Operators](#operators)
- * [Parameters](#parameters)
- * [Return types](#return-types)
- * [Trailing](#trailing)
- * [Smart text](#smart-text)
- * [Templates](#templates)
-* [Config options](#config-options)
-* [Contributors](#contributors)
-* [Known Issues](#known-issues)
-* [What's to come](#whats-to-come)
+- [Generate Doxygen Comments in VS Code](#generate-doxygen-comments-in-vs-code)
+ - [Table of Contents](#table-of-contents)
+ - [Features](#features)
+ - [Alignment](#alignment)
+ - [Attributes](#attributes)
+ - [Con- and Destructors](#con--and-destructors)
+ - [Extensive customization](#extensive-customization)
+ - [File descriptions](#file-descriptions)
+ - [Function pointers](#function-pointers)
+ - [Operators](#operators)
+ - [Parameters](#parameters)
+ - [Return types](#return-types)
+ - [Smart text](#smart-text)
+ - [Trailing](#trailing)
+ - [Templates](#templates)
+ - [Auto-complete doxygen commands](#auto-complete-doxygen-commands)
+ - [Config options](#config-options)
+ - [Contributors](#contributors)
+ - [Known Issues](#known-issues)
+ - [What's to come](#whats-to-come)
## Features
@@ -102,6 +105,11 @@ Each of them can be configured with its own custom text and you can decide if th
![Template method](images/template.gif)
![Template class](images/template-class.gif)
+### Auto-complete doxygen commands
+
+![Auto complete doxygen](images/doxygen-auto-complete.gif)
+
+
## Config options
```json