README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

# Generate Doxygen Comments for VS Code

This VS Code Extensions provides Doxygen Documentation generation on the fly by starting a Doxygen comment block and pressing enter.

[![Build Status](https://travis-ci.org/christophschlosser/doxdocgen.svg?branch=master)](https://travis-ci.org/christophschlosser/doxdocgen)
[![Build status](https://ci.appveyor.com/api/projects/status/4h84071p9tv0y9r6?svg=true)](https://ci.appveyor.com/project/christophschlosser/doxdocgen)

## Features

Generate Doxygen Comments from method signatures.

From simple setter methods

![Simple Parameter](images/param_simple.gif)

over declarations

![Declaration](images/declaration.gif)

to bool return values.

![Bool return val](images/bool.gif)

And some special cases:

Like Constructors

![Constructor](images/ctor.gif)

Multi line definitions/declarations

![method](images/method.gif)

Strip reserved keywords

![keywords](images/keywords.gif)

Or even function pointers *as parameters* (see [Known Issues](#function-pointers))

![func_ptr](images/function_ptr.gif)

Featuring an extensive generation customization system

![options](images/options.gif)
![xml options](images/opts-xml.gif)

## Extension Settings

See [Below](#whats-to-come)

## Contributors

[Christoph Schlosser](https://github.com/christophschlosser)

[Rowan Goemans](https://github.com/rowanG077)

## Known Issues

[See open bugs](https://github.com/christophschlosser/doxdocgen/labels/bug)

## What's to come

* Suggest smart text

* Configuration options
  * Support more configuration options

* Tests

* More languages
  * C++11 and newer