From 235ea5768122a6467c69b1d2a7042aa23acdd456 Mon Sep 17 00:00:00 2001 From: Matthew Kastor Date: Tue, 16 Oct 2012 11:16:06 -0400 Subject: [PATCH] Fix for issue #227 jsDocComment Found typos. All of the code refers to jsdocCommentFound but the documentation and comments in the code refer to jsDocCommentFound. This confused someone for understandable reasons. I've fixed the typos. --- plugins/README.md | 4 ++-- test/specs/jsdoc/src/handlers.js | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/plugins/README.md b/plugins/README.md index cb4027c4..f2080e61 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -76,7 +76,7 @@ source code being documented, like methods provided by a third-party superclass: } } -#### Event: jsDocCommentFound +#### Event: jsdocCommentFound This is fired whenever a jsdoc comment is found. It may or may not be associated with any code. You might use this to modify the contents of a comment before it @@ -253,7 +253,7 @@ of the event parameter. In general the goal is to construct a comment and then get an event to fire. After the parser lets all of the node visitors have a look at the node, it looks to see if the event object has a ```comment``` property and an ```event``` property. If it has both, the event named in the event -property is fired. The event is usually "symbolFound" or "jsDocCommentFound", +property is fired. The event is usually "symbolFound" or "jsdocCommentFound", but theoretically, a plugin could define its own events and handle them. #### Example diff --git a/test/specs/jsdoc/src/handlers.js b/test/specs/jsdoc/src/handlers.js index 0b136513..4f69bc28 100644 --- a/test/specs/jsdoc/src/handlers.js +++ b/test/specs/jsdoc/src/handlers.js @@ -16,7 +16,7 @@ describe("jsdoc/src/handlers", function() { }); describe("attachTo", function() { - it("should attach a 'jsDocCommentFound' handler to the parser", function() { + it("should attach a 'jsdocCommentFound' handler to the parser", function() { var callbacks = testParser.__bindings['jsdocCommentFound']; expect(callbacks).toBeDefined(); expect(callbacks.length).toEqual(1);