diff options
| author | Christoph Schlosser <christoph@linux.com> | 2019-06-28 23:49:40 +0200 |
|---|---|---|
| committer | Christoph Schlosser <christoph@linux.com> | 2019-06-28 23:49:40 +0200 |
| commit | 903fdc1d30c288a9794ebcf9052112712b10080c (patch) | |
| tree | 589fad4429487bce7efbbc8daa756a909ebdfcd6 | |
| parent | c79177e7990359be7cd28146b10f198bd4102b56 (diff) | |
| download | doxdocgen-903fdc1d30c288a9794ebcf9052112712b10080c.tar.gz | |
Document the alignment feature
| -rw-r--r-- | CHANGELOG.md | 41 | ||||
| -rw-r--r-- | README.md | 6 | ||||
| -rw-r--r-- | images/alignment.gif | bin | 0 -> 129756 bytes |
3 files changed, 47 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 0c9ed6d..67605c9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,46 @@ # Change Log +## [0.5.0] + +### Feature + +- Feature suggest: Indent option (#107) + +#### Alignment + +This version introduces the possibility to align text elements in config strings at a specified width. + +Example: + +```json +"doxdocgen.generic.paramTemplate": "@param{indent:10}{param}{indent:30}My Param doc" +``` + +will turn into + +```cpp +/** + * @param foo My Param doc + * @param barIsAlsoAnOption My Param doc + */ +void bar(int foo, int barIsAlsoAnOption); +``` + +You can use the `{indent:<number>}` in any templated config option available. Numbers have to be bigger than 0 to have any effect. + +Alignment will be done from the start of the config string, like this: + +```json +"doxdocgen.generic.paramTemplate": "@param {param}{indent:14}test" +``` + +```cpp +/** + * @param test + */ + |<---------->| // 14 +``` + ## [0.4.3] ### Fix @@ -29,6 +29,12 @@ This VS Code Extensions provides Doxygen Documentation generation on the fly by ## Features +### Alignment + + + +For how this works, see the [CHANGELOG.md](https://github.com/christophschlosser/doxdocgen/blob/master/CHANGELOG.md#alignment) + ### Attributes  diff --git a/images/alignment.gif b/images/alignment.gif Binary files differnew file mode 100644 index 0000000..dc9e9b8 --- /dev/null +++ b/images/alignment.gif |