summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorChristoph Schlosser <christoph@linux.com>2018-02-25 15:33:33 +0100
committerChristoph Schlosser <christophschlosser@users.noreply.github.com>2018-02-25 15:42:53 +0100
commit3379e55daf2b7f94f74815f14c36595453c3bcc1 (patch)
tree13cb3c4030194377d340540ab7f22219fb11b315 /README.md
parent7c33ea0e12d14215f97cbba009e0f36932d47a73 (diff)
downloaddoxdocgen-3379e55daf2b7f94f74815f14c36595453c3bcc1.tar.gz
Update readme
Fix #47
Diffstat (limited to 'README.md')
-rw-r--r--README.md75
1 files changed, 44 insertions, 31 deletions
diff --git a/README.md b/README.md
index a5274f8..3f99f80 100644
--- a/README.md
+++ b/README.md
@@ -6,52 +6,70 @@ This VS Code Extensions provides Doxygen Documentation generation on the fly by
[![Build status](https://ci.appveyor.com/api/projects/status/4h84071p9tv0y9r6?svg=true)](https://ci.appveyor.com/project/christophschlosser/doxdocgen)
[![codecov](https://codecov.io/gh/christophschlosser/doxdocgen/branch/master/graph/badge.svg)](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
-![Simple Parameter](images/param_simple.gif)
+![Attribute](images/attributes.gif)
-over declarations
+### Con- and Destructors
-![Declaration](images/declaration.gif)
+![Constructor](images/ctor.gif)
+![Destructor](images/dtor.gif)
-to bool return values.
+### Extensive customization
-![Bool return val](images/bool.gif)
-
-And some special cases:
+![options](images/options.gif)
+![xml options](images/opts-xml.gif)
-Like Constructors
+### File descriptions
-![Constructor](images/ctor.gif)
+![file description](images/file.gif)
-Multi line definitions/declarations
+### Function pointers
-![method](images/method.gif)
+![func_ptr](images/function_ptr.gif)
-Strip reserved keywords
+### Operators
-![keywords](images/keywords.gif)
+![Operator](images/operator.gif)
+![Delete Operator](images/op-delete.gif)
-Or even function pointers
+### Parameters
-![func_ptr](images/function_ptr.gif)
+![Simple Parameter](images/param_simple.gif)
+![Long Parameter](images/long-param.gif)
-Featuring an extensive generation customization system
+### Return types
-![options](images/options.gif)
-![xml options](images/opts-xml.gif)
+![Bool return val](images/bool.gif)
+![Declaration](images/declaration.gif)
-Generate documentation for the file you just created
+#### Trailing
-![file description](images/file.gif)
+![Trailing return](images/trailing.gif)
-## Extension Settings
+### Templates
-See [Below](#whats-to-come)
+![Template method](images/template.gif)
+![Template class](images/template-class.gif)
## 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)