blob: 3519fc6a2f851c9e7d8f3582edbd8d99818ace2e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
# Change Log
## [0.4.0]
### Feature
- Additional file header fields for version, copyright, and custom text (#89)
## [0.3.3]
### Fix
- Doesn't parse cpp member pointer names correctly (#78)
## [0.3.2]
### Fix
- Cannot read property 'text' of undefined (#79)
## [0.3.1]
### Fix
- Don't create a comment while editing an existing comment. (#67)
## [0.3.0]
### Features
- Custom doxygen tag order for methods (#55)
- Suggest smart text (#57)
For more details see [README.md](https://github.com/christophschlosser/doxdocgen/tree/0.3.0#smart-text)
- Config keys are now grouped, see [Config update](#config-update) for changes
### Config update
| Old value | New value | Change |
|---------------------------------------|----------------------------------------|:--------:|
| doxdocgen.generic.triggerSequence | doxdocgen.c.triggerSequence | Category |
| doxdocgen.generic.firstLine | doxdocgen.c.firstLine | Category |
| doxdocgen.generic.commentPrefix | doxdocgen.c.commentPrefix | Category |
| doxdocgen.generic.lastLine | doxdocgen.c.lastLine | Category |
| | doxdocgen.c.setterText | Added |
| | doxdocgen.c.getterText | Added |
| | doxdocgen.c.factoryMethodText | Added |
| doxdocgen.generic.newLineAfterTParams | | Removed |
| doxdocgen.generic.newLineAfterBrief | | Removed |
| doxdocgen.generic.newLineAfterParams | | Removed |
| doxdocgen.generic.tparamTemplate | doxdocgen.cpp.tparamTemplate | Category |
| | doxdocgen.cpp.ctorText | Added |
| | doxdocgen.cpp.dtorText | Added |
| doxdocgen.generic.fileTemplate | doxdocgen.file.fileTemplate | Category |
| doxdocgen.generic.fileOrder | doxdocgen.file.fileOrder | Category |
| | doxdocgen.generic.generateSmartText | Added |
| | doxdocgen.generic.splitCasingSmartText | Added |
| | doxdocgen.generic.order | Added |
## [0.2.1]
- Hotfix. Include moment.js as runtime dependency
## [0.2.0]
- Fix #51
- Fix #52
## [0.1.0]
- Fix #40
- Fix #38
- Fix #37
- Fix #36
- Fix #28
- Fix #24
- Implemented support for noexcept and throw
- Implemented support for constexpr and final
- Implemented support for unnamed parameters, this broke in version 0.0.7
- Add new config variable that allows a user to disable the true and false return on bool types and make it behave like a normal type
## [0.0.7]
- Fix #31
- Fixed bug where using a different trigger sequence then "*" causes a newline to be addd between the comment and the documented entity.
## [0.0.6]
- Improve and fix comment generation for several C++ features (#23) (thanks to @rowanG077 again)
## [0.0.5]
- Extend customization of generated documentation (#15, #16) (thanks to @rowanG077)
- Fix #10
## [0.0.4]
- Fix #9
- Add option to choose if the return type should be included in generated documentation
## [0.0.3]
- Add possibility to set comment start indicator to Qt style
## [0.0.2]
- Add C parser and generator
## [0.0.1]
- Initial release
|