Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.5.0 changelog? #130

Closed
dougwilson opened this issue Sep 6, 2014 · 2 comments
Closed

0.5.0 changelog? #130

dougwilson opened this issue Sep 6, 2014 · 2 comments

Comments

@dougwilson
Copy link

it looks like History.md was never updated for 0.5.0 and there seems to be a lot of commits to look through to figure out the changes.

@Twipped
Copy link
Collaborator

Twipped commented Sep 6, 2014

This is a rough list, @evindor can probably clean it up for the file.

  • Marked options can now be set via dox.setMarkedOptions
  • Comment blocks now include line and codeStart to mark the first line of the comment block and the first line of the code context.
  • Now ignores jshint, jslint and eslint directives. This can be overridden or added to via the skipPrefixes option and the --skipPrefixes command line flag, which takes a comma separated list of prefixes.
  • The code field now trims extra indentation based on the indentation of the first line of code.
  • Now sets the isConstructor property when a @constructor tag is present and changes ctx.type to constructor.
  • Now recognizes the following code contexts:
    • Foo.prototype.bar; (property)
    • Foo.prototype = { (prototype)
    • foo: function () {(method)
    • foo: bar (property)
    • get foo () {(property)
    • set foo () { (property)
  • When a comment is present to identify the definition of an object literal, comments for the object's members will include a ctx.constructor property identifying the parent object.
  • Fixed: Multi-line comments with no space following the star are now parsed correctly.
    • Example: /*comment*/
  • Fixed: A code context of Foo.prototype.bar = null; is now parsed correctly.
  • Top contributors (according to github) have been added to package.json
  • Readme now includes an example of using dox programmatically.

@Twipped
Copy link
Collaborator

Twipped commented Sep 6, 2014

Found a few more after I did a diff since 0.4.6:

  • @param tags now include an optional attribute
  • @returns is now recognized as an alias for @return
  • Now supports comments without descriptions (ex: /** @name Foo **/)
  • Fixed: Crash with the --api flag when no headers are generated.
  • Fixed: --api output now includes aliases.

@evindor evindor closed this as completed in 793d6ea Sep 7, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants