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
1,321 Commits 10 Branches 386 Tags
Commit Graph

102 Commits

Author SHA1 Message Date
Jeff Williams
cfd9743eaa remove extra period from end of summary 2014-07-28 18:49:53 -07:00
Jeff Williams
ca62994d22 clean up/rename summarize plugin, and add tests 2014-07-26 19:51:55 -07:00
Jeff Williams
fa53887490 Plugin to automatically extract a summary, if missing, from the first sentence in the description 
This plugin (tries to) extract a summary, if missing, from the first sentence in the description.

It does this by splitting at the first . that is followed by a whitespace or an HTML tag. Afterwards, it appends a ., balances any HTML tags and removes a begin-end pair of P tags.

The result is pretty useful, if the documenter has not "bothered" to write a summary and description tag.

Author: Mads Bondo Dydensborg <mbd@dbc.dk>
 2014-07-26 15:06:59 -07:00
Jeff Williams
b5653b838c update ESLint rules for ESLint 0.7.1 
Fixes a Travis CI build failure.
 2014-07-07 21:36:20 -07:00
Jeff Williams
db7e65deb1 enable ESLint quotes rule (and associated cleanup) 2014-04-19 10:44:07 -07:00
Jeff Williams
bce238bb51 replace JSHint with ESLint (and associated cleanup) 2014-04-19 10:38:02 -07:00
Jeff Williams
49ad746e49 trailing whitespace cleanup 2014-03-04 13:47:57 -08:00
Jeff Williams
48e6c392d5 huge whitespace cleanup 
- remove all trailing whitespace
- for consistency, replace all tabs with spaces
 2014-03-03 07:43:01 -08:00
Jeff Williams
c96a1215bd add a warning about potential crashes (#554) 2014-02-01 19:36:34 -08:00
Jeff Williams
ae93b5e614 add omitNodes option to hide AST nodes 2014-01-26 15:05:15 -08:00
Jeff Williams
733eb6bc47 log objects in events more consistently 2014-01-26 09:37:36 -08:00
Jeff Williams
c9b0237c12 overhaul logging and error handling (#416) 2013-12-23 15:25:28 -08:00
Jeff Williams
f55feb1a0e 'use strict'ify 2013-11-11 23:49:54 -08:00
Jeff Williams
6651a85b35 Merge branch 'master' into parsimony 
Conflicts:
	lib/jsdoc/src/filter.js
	lib/jsdoc/src/scanner.js
	package.json
	test/specs/jsdoc/src/filter.js
	test/specs/jsdoc/src/scanner.js
	test/specs/tags/exportstag.js
 2013-11-04 08:54:46 -08:00
Jeff Williams
99ab99298d add partial test infrastructure to support testing multiple parsers in one runtime 
not fully implemented.
 2013-11-04 06:46:47 -08:00
Jeff Williams
84188d6e62 don't escape inline HTML in Markdown-tagged text; remove markdown-js parser, and default to marked (#510) 2013-11-02 12:37:34 -07:00
Jeff Williams
7ac6bfee1c cleanup 2013-10-31 15:32:08 -07:00
Jeff Williams
e17b785a43 whitespace 2013-10-31 09:25:24 -07:00
Jeff Williams
751bea1b0a fixes for Node.js compatibility (see details) 
- new Rhino .jar to help find module paths
(https://github.com/hegemonic/rhino/commit/31b70105)
- make __dirname and process.cwd() provide the current module path; use
only env.dirname for JSDoc's home dir; fix callers
- get rid of jsdoc/util/include (and update test framework accordingly)
- avoid running Rhino/Node.js tests on the wrong runtime
- remove support for global 'publish' function, which relied upon
jsdoc/util/include
- update jsdoc/util/dumper for consistency with Node.js'
JSON.stringify()
- fix jsdoc/util/runtime to detect Node.js correctly
- add Node.js versions of jsdoc/fs and jsdoc/path
- other minor cleanup
 2013-10-25 23:30:56 -07:00
Ernst Haagsman
d4ee1d324e Plugins: Created processingComplete event 
The processingComplete event fires after all processing has been
done. It gets the entire docs as its only parameter.
 2013-05-10 11:56:34 +02:00
Jeff Williams
f97803ad69 use Object.keys instead of Object.hasOwnProperty where possible 2013-05-02 20:06:04 -07:00
Jeff Williams
140883c553 Merge pull request #297 from phasmal/add-see-tag-support 
Added support for @see tag in markdown plugin
 2013-04-19 15:08:33 -07:00
Jeff Williams
359fa84d3c add plugin making it easier to link to overloaded methods (#179) 2013-04-15 06:55:45 -07:00
Jeff Williams
eb9d95fa60 add 'parseBegin' and 'parseComplete' events (#299) 2013-03-23 18:37:04 -07:00
Jeff Williams
23914496ea Merge pull request #360 from Billiam/fix/markdown-exclude-tags-337 
Add excludeTags config option for markdown plugin
 2013-03-23 18:09:15 -07:00
Jeff Williams
f0224e9845 don't crash if a file does not contain any comments (#368) 2013-03-21 12:41:04 -07:00
Billiam
282fc16e49 Adding excludeTags to markdown config. 2013-03-09 23:14:33 -06:00
Jeff Williams
370c1ea1e7 update plugin docs 2013-01-27 08:37:31 -08:00
Jeff Williams
87cd24728f allow plugins to be installed outside of the JSDoc directory (#277) 2013-01-27 07:56:43 -08:00
Jeff Williams
5df93a0136 improvements to eventDumper plugin 2013-01-26 08:07:09 -08:00
Jeff Williams
964f6e97e2 Merge branch 'master' of https://github.com/jsdoc3/jsdoc 2013-01-22 20:36:39 -08:00
Jeff Williams
5df4fd432d update the default template to generate pretty-printed source files (#208) 
enabled by default. to disable pretty-printed source files, add the
property templates.default.outputSourceFiles: false to your conf.json
file.
 2013-01-22 20:34:41 -08:00
mathematicalcoffee
7678689278 for jsdoc3/jsdoc3.github.com#5 - mention jsdoc/util/error in plugin docs 2013-01-18 14:43:42 +10:00
Jeff Williams
2ad44a6c6a remove stray console.log 2013-01-15 08:39:11 -08:00
Jeff Williams
5880a7bd79 add plugin that removes everything except JSDoc comments from source files (#304) 2013-01-15 08:26:31 -08:00
phasmal
d7ea22b6f2 removed some tab chars 2013-01-03 13:14:51 +11:00
phasmal
554917137b Fixed jshint-clean issues reported on github .. again 2013-01-03 12:40:46 +11:00
phasmal
427a46177d Added support for @see tag in markdown plugin, including adding 'see' to default list and fixing recursion into Arrays 2013-01-03 11:43:46 +11:00
Jeff Williams
d73570defc make fs module consistent with Node.js (#211) 2012-12-26 19:03:05 -08:00
Jeff Williams
e4236eaa42 remove most globals from jsdoc.js (#287) 
for clarity, also forward-declared all variables in main()
 2012-12-25 04:55:50 -08:00
Jeff Williams
a17c90dfd2 deprecate env.dirname in favor of __dirname (#286) 
plus some minor cleanup to address JSHint warnings
 2012-12-23 09:45:11 -08:00
Jeff Williams
10cd4a077d get rid of superfluous [[string0]] on console when running tests 2012-10-30 22:55:32 -07:00
Jeff Williams
589eb300c8 add plugin to dump parser events to the console (#242) 2012-10-28 17:17:13 -07:00
Jeff Williams
65e4a47201 Merge branch 'master' of https://github.com/jsdoc3/jsdoc 
Conflicts:
	plugins/prettyPrintSource.js
 2012-10-20 15:37:54 -07:00
Jeff Williams
3f60724f92 fix JSHint errors (again) 2012-10-20 15:36:59 -07:00
Matthew Kastor
202357d4d0 jslint doesn't like comment switches 
The block is toggled by deleting /*
/*// Explanation of junk
somejunk
//*/
 2012-10-20 18:34:55 -04:00
Matthew Kastor
7ebf9c5976 prettyPrintSource now uses it's own template 
now that the templates.js file is fixed, plugins can use templates
without trashing everything.
 2012-10-20 18:20:33 -04:00
Jeff Williams
97e5cb9bf2 fix bad regexp in JSHint test; make plugins JSHint-clean 2012-10-20 15:06:56 -07:00
Jeff Williams
5295803fc7 replace all types of line endings 2012-10-19 22:07:42 -07:00
Jeff Williams
cab6e29ebd Merge branch 'markdown-refactor' 
Conflicts:
	plugins/markdown.js
	rhino_modules/jsdoc/readme.js
	rhino_modules/jsdoc/tutorial.js
 2012-10-19 21:34:44 -07:00