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

update internal explain comments #2515

Merged
merged 1 commit into from
Mar 21, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 7 additions & 6 deletions src/directive.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,21 @@ function noop () {}
* It registers a watcher with the expression and calls
* the DOM update function when a change is triggered.
*
* @param {String} name
* @param {Node} el
* @param {Vue} vm
* @param {Object} descriptor
* - {String} name
* - {Object} def
* - {String} expression
* - {Array<Object>} [filters]
* - {Object} [modifiers]
* - {Boolean} literal
* - {String} attr
* - {String} arg
* - {String} raw
* @param {Object} def - directive definition object
* - {String} [ref]
* - {Array<Object>} [interp]
* - {Boolean} [hasOneTime]
* @param {Vue} vm
* @param {Node} el
* @param {Vue} [host] - transclusion host component
* @param {Object} [scope] - v-for scope
* @param {Fragment} [frag] - owner fragment
Expand Down Expand Up @@ -68,8 +71,6 @@ export default function Directive (descriptor, vm, el, host, scope, frag) {
* Initialize the directive, mixin definition properties,
* setup the watcher, call definition bind() and update()
* if present.
*
* @param {Object} def
*/

Directive.prototype._bind = function () {
Expand Down
1 change: 1 addition & 0 deletions src/fragment/fragment.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import {
* @param {DocumentFragment} frag
* @param {Vue} [host]
* @param {Object} [scope]
* @param {Fragment} [parentFrag]
*/

export default function Fragment (linker, vm, frag, host, scope, parentFrag) {
Expand Down
5 changes: 5 additions & 0 deletions src/instance/api/lifecycle.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ export default function (Vue) {
/**
* Teardown the instance, simply delegate to the internal
* _destroy.
*
* @param {Boolean} remove
* @param {Boolean} deferCleanup
*/

Vue.prototype.$destroy = function (remove, deferCleanup) {
Expand All @@ -59,6 +62,8 @@ export default function (Vue) {
*
* @param {Element|DocumentFragment} el
* @param {Vue} [host]
* @param {Object} [scope]
* @param {Fragment} [frag]
* @return {Function}
*/

Expand Down
4 changes: 1 addition & 3 deletions src/instance/internal/lifecycle.js
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,8 @@ export default function (Vue) {
/**
* Create and bind a directive to an element.
*
* @param {String} name - directive name
* @param {Object} descriptor - parsed directive descriptor
* @param {Node} node - target node
* @param {Object} desc - parsed directive descriptor
* @param {Object} def - directive definition object
* @param {Vue} [host] - transclusion host component
* @param {Object} [scope] - v-for scope
* @param {Fragment} [frag] - owner fragment
Expand Down
2 changes: 1 addition & 1 deletion src/observer/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Observer.prototype.removeVm = function (vm) {
* the prototype chain using __proto__
*
* @param {Object|Array} target
* @param {Object} proto
* @param {Object} src
*/

function protoAugment (target, src) {
Expand Down
2 changes: 1 addition & 1 deletion src/parsers/directive.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ function processFilterArg (arg) {
* ]
* }
*
* @param {String} str
* @param {String} s
* @return {Object}
*/

Expand Down
2 changes: 1 addition & 1 deletion src/watcher.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ let uid = 0
* This is used for both the $watch() api and directives.
*
* @param {Vue} vm
* @param {String} expression
* @param {String|Function} expOrFn
* @param {Function} cb
* @param {Object} options
* - {Array} filters
Expand Down