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 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) (limited to 'CHANGELOG.md') 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 -- cgit v1.2.3