diff options
| -rw-r--r-- | README.md | 75 | ||||
| -rw-r--r-- | images/attributes.gif | bin | 0 -> 93346 bytes | |||
| -rw-r--r-- | images/dtor.gif | bin | 0 -> 61049 bytes | |||
| -rw-r--r-- | images/long-param.gif | bin | 0 -> 58785 bytes | |||
| -rw-r--r-- | images/op-delete.gif | bin | 0 -> 58818 bytes | |||
| -rw-r--r-- | images/operator.gif | bin | 0 -> 71767 bytes | |||
| -rw-r--r-- | images/template-class.gif | bin | 0 -> 115569 bytes | |||
| -rw-r--r-- | images/template.gif | bin | 0 -> 76464 bytes | |||
| -rw-r--r-- | images/trailing.gif | bin | 0 -> 91633 bytes |
9 files changed, 44 insertions, 31 deletions
@@ -6,52 +6,70 @@ This VS Code Extensions provides Doxygen Documentation generation on the fly by [](https://ci.appveyor.com/project/christophschlosser/doxdocgen) [](https://codecov.io/gh/christophschlosser/doxdocgen) -## Features +## Table of Contents + +* [Features](#features) + * [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) + * [Templates](#templates) +* [Contributors](#contributors) +* [Known Issues](#known-issues) +* [What's to come](#whats-to-come) -Generate Doxygen Comments from method signatures. +## Features -From simple setter methods +### Attributes - + -over declarations +### Con- and Destructors - + + -to bool return values. +### Extensive customization - - -And some special cases: + + -Like Constructors +### File descriptions - + -Multi line definitions/declarations +### Function pointers - + -Strip reserved keywords +### Operators - + + -Or even function pointers +### Parameters - + + -Featuring an extensive generation customization system +### Return types - - + + -Generate documentation for the file you just created +#### Trailing - + -## Extension Settings +### Templates -See [Below](#whats-to-come) + + ## Contributors @@ -65,9 +83,4 @@ See [Below](#whats-to-come) ## What's to come -* Suggest smart text - -* Configuration options - * Support more configuration options - -* More languages +[See open features](https://github.com/christophschlosser/doxdocgen/labels/enhancement) diff --git a/images/attributes.gif b/images/attributes.gif Binary files differnew file mode 100644 index 0000000..c3a5003 --- /dev/null +++ b/images/attributes.gif diff --git a/images/dtor.gif b/images/dtor.gif Binary files differnew file mode 100644 index 0000000..13f9afe --- /dev/null +++ b/images/dtor.gif diff --git a/images/long-param.gif b/images/long-param.gif Binary files differnew file mode 100644 index 0000000..23babd2 --- /dev/null +++ b/images/long-param.gif diff --git a/images/op-delete.gif b/images/op-delete.gif Binary files differnew file mode 100644 index 0000000..dee2316 --- /dev/null +++ b/images/op-delete.gif diff --git a/images/operator.gif b/images/operator.gif Binary files differnew file mode 100644 index 0000000..d138bb9 --- /dev/null +++ b/images/operator.gif diff --git a/images/template-class.gif b/images/template-class.gif Binary files differnew file mode 100644 index 0000000..1fd446a --- /dev/null +++ b/images/template-class.gif diff --git a/images/template.gif b/images/template.gif Binary files differnew file mode 100644 index 0000000..986b819 --- /dev/null +++ b/images/template.gif diff --git a/images/trailing.gif b/images/trailing.gif Binary files differnew file mode 100644 index 0000000..5261722 --- /dev/null +++ b/images/trailing.gif |
