archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #421 from ErnstHaagsman/processingcomplete-event

Browse Source 
Plugins: Created processingComplete event
This commit is contained in:
Jeff Williams 2013-06-02 16:45:01 -07:00
commit 0f79895be2
4 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
jsdoc.js
View File

@ -237,6 +237,8 @@ function main() {
jsdoc.augment.addInherited(docs);
jsdoc.borrow.resolveBorrows(docs);
app.jsdoc.parser.fireProcessingComplete({doclets: docs});
if (env.opts.explain) {
dump(docs);
process.exit(0);

4
lib/jsdoc/src/parser.js
View File

@ -97,6 +97,10 @@ exports.Parser.prototype.parse = function(sourceFiles, encoding) {
return this._resultBuffer;
};
exports.Parser.prototype.fireProcessingComplete = function(doclets) {
this.emit('processingComplete', doclets);
};
/**
* @returns {Array<Doclet>} The accumulated results of any calls to parse.
*/

3
plugins/eventDumper.js
View File

@ -19,7 +19,8 @@ var events = conf.include || [
'symbolFound',
'newDoclet',
'fileComplete',
'parseComplete'
'parseComplete',
'processingComplete'
];
// Don't dump the excluded parser events
if (conf.exclude) {

8
test/specs/jsdoc/src/parser.js
View File

@ -77,6 +77,14 @@ describe("jsdoc/src/parser", function() {
expect(spy).toHaveBeenCalled();
expect(spy.mostRecentCall.args[0].sourcefiles).toEqual(["[[string0]]"]);
});
it("should fire processingComplete when fireProcessingComplete is called", function() {
var spy = jasmine.createSpy(),
doclets = {doclets: ['a','b']};
parser.on('processingComplete', spy).fireProcessingComplete(doclets);
expect(spy).toHaveBeenCalled();
expect(spy.mostRecentCall.args[0]).toEqual(doclets);
});
it("should be able to parse its own source file", function() {
var fs = require('jsdoc/fs'),