From 903fdc1d30c288a9794ebcf9052112712b10080c Mon Sep 17 00:00:00 2001 From: Christoph Schlosser Date: Fri, 28 Jun 2019 23:49:40 +0200 Subject: Document the alignment feature --- CHANGELOG.md | 41 +++++++++++++++++++++++++++++++++++++++++ README.md | 6 ++++++ images/alignment.gif | Bin 0 -> 129756 bytes 3 files changed, 47 insertions(+) create mode 100644 images/alignment.gif 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:}` 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 diff --git a/README.md b/README.md index 193fd60..32dd759 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,12 @@ This VS Code Extensions provides Doxygen Documentation generation on the fly by ## Features +### Alignment + +![Alignment](images/alignment.gif) + +For how this works, see the [CHANGELOG.md](https://github.com/christophschlosser/doxdocgen/blob/master/CHANGELOG.md#alignment) + ### Attributes ![Attribute](images/attributes.gif) diff --git a/images/alignment.gif b/images/alignment.gif new file mode 100644 index 0000000..dc9e9b8 Binary files /dev/null and b/images/alignment.gif differ -- cgit v1.2.3