diff options
| author | Christoph Schlosser <christoph@linux.com> | 2018-02-25 15:33:33 +0100 |
|---|---|---|
| committer | Christoph Schlosser <christophschlosser@users.noreply.github.com> | 2018-02-25 15:42:53 +0100 |
| commit | 3379e55daf2b7f94f74815f14c36595453c3bcc1 (patch) | |
| tree | 13cb3c4030194377d340540ab7f22219fb11b315 /README.md | |
| parent | 7c33ea0e12d14215f97cbba009e0f36932d47a73 (diff) | |
| download | doxdocgen-3379e55daf2b7f94f74815f14c36595453c3bcc1.tar.gz | |
Update readme
Fix #47
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 75 |
1 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) |