<commit_before># 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)

Defintions in header files

![definition](images/definition.gif)

Multi line definitions/declarations

![method](images/method.gif)

Or void return values

![void](images/void.gif)

## Extension Settings

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

## Known Issues

Completely new extension, so none.

## What's to come

* Suggest smart text

* Configuration options
  * Support more configuration options

* Tests

* More languages
  * C++11 and newer

* Improve language support
  * Classes
  * Namespaces
  * Enums<commit_msg>Add function pointers to known issues<commit_after># 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)

Defintions in header files

![definition](images/definition.gif)

Multi line definitions/declarations

![method](images/method.gif)

Or void return values

![void](images/void.gif)

## Extension Settings

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

## Contributors

[<NAME>](https://github.com/christophschlosser)

[<NAME>](https://github.com/rowanG077)

## Known Issues

### Function pointers

See [#18](https://github.com/christophschlosser/doxdocgen/issues/18)

Documentation for certain constructs (like the following) may not be generated correctly.

```C
int (*idputs(int (*puts)(const char *)))(const char *)
```

## What's to come

* Suggest smart text

* Configuration options
  * Support more configuration options

* Tests

* More languages
  * C++11 and newer

* Improve language support
  * Classes
  * Namespaces
  * Enums
{'fraction_non_alphanumeric': 0.11480865224625623, 'fraction_numerical': 0.010316139767054908, 'mean_word_length': 5.341772151898734, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 11, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3413023', 'n_tokens_mistral': 981, 'n_tokens_neox': 926, 'n_words': 245}