Skip to content

Commit

Permalink
More cleanup after repo move
Browse files Browse the repository at this point in the history
  • Loading branch information
wiggin77 committed Feb 10, 2017
1 parent 3dc8914 commit e6078a8
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 50 deletions.
19 changes: 10 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,28 @@

## 1.2.4

* Fix [issue 16](https://github.com/wiggin77/codedox/issues/16) support newlines in commentdescription, paramFormat, returnFormat
* New config option `alwaysMultiline:true`. If true then all comments are multiline, otherwise non-functions (types) are single line.
* Repo moved to [vshaxe](https://github.com/vshaxe) organization
* Fix [issue 16](https://github.com/vshaxe/codedox/issues/16) support newlines in commentdescription, paramFormat, returnFormat
* New config option `alwaysMultiline:true`. If true then all comments are multiline, otherwise non-functions (types) are single line
* OnEnter rules dynamically generated for custom configs
* Fix [issue 12](https://github.com/wiggin77/codedox/issues/12) Spaces added for non-function docs
* Fix [issue 10](https://github.com/wiggin77/codedox/issues/10) "commentend" & "commentprefix" have hardcoded space
* Fix [issue 8](https://github.com/wiggin77/codedox/issues/8) Params using type inference not handled properly
* Fix [issue 12](https://github.com/vshaxe/codedox/issues/12) Spaces added for non-function docs
* Fix [issue 10](https://github.com/vshaxe/codedox/issues/10) "commentend" & "commentprefix" have hardcoded space
* Fix [issue 8](https://github.com/vshaxe/codedox/issues/8) Params using type inference not handled properly
* Prepare for additional languages

## 1.2.3

* Fix "window.activeTextEditor can be null" via [Gamma11 PR](https://github.com/wiggin77/codedox/pull/5)
* Fix [issue 4](https://github.com/wiggin77/codedox/issues/4) Debug output in release
* Fix "window.activeTextEditor can be null" via [Gamma11 PR](https://github.com/vshaxe/codedox/pull/5)
* Fix [issue 4](https://github.com/vshaxe/codedox/issues/4) Debug output in release
* Fixed README typos

## 1.2.2

* Fix [issue 3](https://github.com/wiggin77/codedox/issues/3) - determine if indentation should use tabs based on function being documented, not `editor.insertSpaces`
* Fix [issue 3](https://github.com/vshaxe/codedox/issues/3) - determine if indentation should use tabs based on function being documented, not `editor.insertSpaces`
* Added option to include/remove the '?' prefix for optional function args in @param tags

## 1.2.1
* Allow customizable formats for @param and @return tags. [issue 1](https://github.com/wiggin77/codedox/issues/1)
* Allow customizable formats for @param and @return tags. [issue 1](https://github.com/vshaxe/codedox/issues/1)

## 1.2.0
* Setup wizard to create minimal config without editing settings.json by hand
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ If you want to create a custom license/copyright template or want to change how
"paramFormat": "@param ${name} - ", // supports ${name} and ${type}, plus built-in params
"returnFormat": "@return ${type}", // supports ${type}, plus built-in params
"allowOptionalArgs": false, // false strips the '?' prefix from optional function args
"alwaysMultiline": true, // if false non-functions (types) are single line
"commentprefix": "* ",
"commentbegin": "/**",
"commentend": "*/",
Expand Down
20 changes: 0 additions & 20 deletions TODO.md

This file was deleted.

21 changes: 0 additions & 21 deletions sample.codedox.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,6 @@
"headerprefix": " *",
"headerbegin": "/*",
"headerend": " */",

"languages":
{
"haxe":
{
"autoInsert": true,
"autoInsertHeader": true,
"autoPrefixOnEnter": true,
"paramFormat": "@param ${name} - ",
"returnFormat": "@return ${type}",
"allowOptionalArgs": false,
"commentprefix": " * ",
"commentbegin": "/**",
"commentend": " */",
"commentdescription": "[Description]",
"headerprefix": " *",
"headerbegin": "/*",
"headerend": " */"
}
},

"fileheader": {
"params": {
"*": {
Expand Down

0 comments on commit e6078a8

Please sign in to comment.