fixes, tweaks, functionality #53
Conversation
|
thanks for the PR, @boneskull. Looks good to me at first read. Since there's quite a bit to chew on, I'll leave a few days for other people to comment. Then I'll give it a try and merge it in. |
| @@ -65,6 +65,7 @@ function printHelp(){ | |||
| console.log(' -v, --version\t\t Prints the current version and quits.'); | |||
| console.log(' -o, --output\t\t Output directory.'); | |||
| console.log(' -t, --templateDir\t Template directory to use instead of built-in ones.'); | |||
| console.log(' -p, --private\t Ignore private members'); | |||
There was a problem hiding this comment.
Doesn't seem to be implemented. Please remove.
There was a problem hiding this comment.
oops thought I zapped that. can fix.
|
Great work @boneskull! Thanks for this valuable contribution. @psq Looks good to me; tested locally and all is well. Ideally, we'd have tests in I created a few issues of post-merge cleanup items, but those shouldn't stop this PR from being accepted. @psq Feel free to merge when you're ready. |
|
updated PR w/ fixes |
|
regarding the last commit (boneskull@dfa50f6) we should really have the styling changes in separate PR so they can be discussed on their own (see the newly added https://github.com/sutoiku/jsdox/blob/master/Contributing.md) @mrjoelkemp ok with it? |
|
@psq Agreed. @boneskull Please extract the template changes from your last commit into a separate PR. I'd like to have this merged in, but cosmetic changes of the templates should be done via using the |
- fixes: - `-A` option was ignored and became the default; fixed so it is no longer the default - fixed issue wherein description of `@return` would become `@description` of function (duplicated) if not set for `@return` - removed redundant `jshint-config.json` - fixed `.jshintrc` - fixed inability to find configuration file - enhancements - added `.editorconfig` so my editor doesn't blast trailing spaces in `.mustache` files - `@example` tag support - `@property` tag support - `@private` tag support - added types for class members -
|
@mrjoelkemp done |
|
👍 |
fixes, tweaks, functionality merging, even though we could have included the template changes to benefit from `@example` and `@property`, and a new fixture to show an example of these 2 new tags. We'll include these with #59.
@privatetag.@descriptionwould be duplicated in a@returnstag having no description of its own.jshintrcand removed unusedjshint-config.json@description@exampletag@propertytag@propertytag and members@authortag display from@licensetag display in templatemonospaceExample output