summaryrefslogtreecommitdiffstats
path: root/CHANGELOG.md
diff options
context:
space:
mode:
authorChristoph Schlosser <christoph@linux.com>2019-06-28 23:49:40 +0200
committerChristoph Schlosser <christoph@linux.com>2019-06-28 23:49:40 +0200
commit903fdc1d30c288a9794ebcf9052112712b10080c (patch)
tree589fad4429487bce7efbbc8daa756a909ebdfcd6 /CHANGELOG.md
parentc79177e7990359be7cd28146b10f198bd4102b56 (diff)
downloaddoxdocgen-903fdc1d30c288a9794ebcf9052112712b10080c.tar.gz
Document the alignment feature
Diffstat (limited to 'CHANGELOG.md')
-rw-r--r--CHANGELOG.md41
1 files changed, 41 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