Dominic Chambers
fea85645e0
Display the class description even when the class is defined within a
...
module.
2014-08-19 17:45:33 +01:00
Dominic Chambers
f2f8d74d22
Added failing test that should work (it works within the template) and
...
which otherwise explains how the class information is available for use
within module documentation pages.
2014-08-19 17:41:56 +01:00
Dominic Chambers
28cb42de33
Added missing coverage around modules that contain a default CommonJs
...
class being exported within the module -- this has actually shown that
the doclets produced are probably correct, and that the bug is likely to
be within the template.
2014-08-19 16:53:58 +01:00
Jeff Williams
2ed4a0320b
if we can't find the scope for a virtual comment, set the doclet's scope to global ( #684 )
2014-08-18 17:32:21 -07:00
Jeff Williams
109ae920a6
correct comments
2014-08-18 16:49:46 -07:00
Jeff Williams
019ebb538f
only show a module's summary info once ( #701 )
2014-08-18 16:13:53 -07:00
Jeff Williams
482d34cc5e
cleanup
2014-08-18 15:51:48 -07:00
Jeff Williams
4479e69578
don't show modules on the Globals page ( #700 )
2014-08-18 14:55:40 -07:00
Jeff Williams
5d454d45be
correct comment
2014-08-16 09:05:25 -07:00
Jeff Williams
b6bfcadf00
add more information to the doclet index ( #725 )
...
We now index doclets as follows:
+ all doclets by longname
+ all documented symbols by longname
+ all doclets with `borrowed` properties
By expanding the index, we reduce the number of times that `jsdoc/augment` and `jsdoc/borrow` must iterate over all doclets. As a result, large docsets are processed much more quickly.
2014-08-16 08:58:17 -07:00
Jeff Williams
46d89d169c
clean up requires
2014-08-15 10:45:56 -07:00
Jeff Williams
4a551cdf34
update the events module for Rhino
2014-08-15 10:11:20 -07:00
Jeff Williams
667aa7371d
update LICENSE
2014-08-15 09:11:10 -07:00
Jeff Williams
9be79c198e
refactor
2014-08-14 14:20:25 -07:00
Jeff Williams
17fb5be064
for Closure, allow the type tag to have a description ( #732 )
2014-08-13 21:53:11 -07:00
Jeff Williams
180454c3a8
rename file for consistency
2014-08-13 21:45:30 -07:00
Jeff Williams
e8b692b334
allow the Closure version of the protected tag to specify a type ( #731 )
...
Also adds tests for the `protected` tag.
2014-08-13 17:04:47 -07:00
Jeff Williams
21e0dbad25
allow the Closure version of the private tag to specify a type ( #730 )
2014-08-13 15:32:51 -07:00
Jeff Williams
addee8ea7e
split up the JSDoc and Closure Compiler tag definitions ( #729 )
...
A new `tags.dictionaries` config setting allows you to choose which definitions to enable.
If a tag is defined in more than one dictionary, JSDoc will use the definition from the first dictionary.
2014-08-13 13:39:14 -07:00
Jeff Williams
f9c593824f
turn the dictionary module into an instantiable class
2014-08-12 16:21:37 -07:00
Jeff Williams
291e254296
add new test fixture ( #727 )
2014-08-12 10:47:37 -07:00
Jeff Williams
61e637bae6
if a module exports only an overloaded method, show every version of the method ( #727 )
2014-08-12 09:50:11 -07:00
Jeff Williams
89237260c6
support virtual comments for overloaded symbols ( #727 )
2014-08-12 09:37:00 -07:00
Jeff Williams
2f87fb11dc
improvements to interface and implements tags
...
- Change doclet property names
- Populate the list of property implementations in augment.js, not in the template
- Tone down the presentation of both tags in the default template
- Other related cleanup
2014-08-11 16:02:00 -07:00
Jeff Williams
277d712f3e
cleanup
2014-08-11 16:02:00 -07:00
Jeff Williams
7ef13bf40b
prevent crash when a class claims to implement an interface but has no members
2014-08-11 16:01:59 -07:00
Jeff Williams
7c2a6d7438
cleanup
2014-08-11 16:01:59 -07:00
MinHyeong Kim
87c33e242b
modify codes for generate describe interface's all properties.
2014-08-11 16:01:59 -07:00
MinHyeong Kim
c797b50c49
uncomment test code.
2014-08-11 16:01:59 -07:00
MinHyeong Kim
cc9ceb700b
fix codes for patch. excepts 'implements not functions' issue.
2014-08-11 16:01:59 -07:00
MinHyeong Kim
52426cd3a7
add test codes for @interface, @implements annotations.
2014-08-11 16:01:59 -07:00
MinHyeong Kim
ef70ffe2bd
modify codes for @interface, @implements annotation.
2014-08-11 16:01:59 -07:00
Jeff Williams
d09c654d36
prevent a crash if a doclet has an empty longname
2014-08-07 13:17:54 -07:00
Jeff Williams
c2d3d0041b
add getAncestors and getUniqueId helpers
2014-08-06 15:32:06 -07:00
Jeff Williams
d220954d97
doc fixes
2014-08-06 15:23:43 -07:00
Jeff Williams
ead0e90409
handle variations when generating a tree of longnames
2014-08-03 11:44:42 -07:00
Jeff Williams
1171593908
parsedType property improvements ( #576 )
...
- Make the parsedType property non-enumerable unless debug mode is enabled.
- Add a more appropriate test case.
- Remove the (incomplete) schema for parsed types.
2014-07-30 12:04:10 -07:00
Jeff Williams
2dec7bd4e0
expose parsed type in doclets ( #576 )
...
Author: Alexey Malutin (https://github.com/Alexey-Malutin )
2014-07-30 10:53:10 -07:00
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
c557cd0a8b
use the correct type expression for type applications that contain type unions ( #714 )
2014-07-26 14:16:25 -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
333ac90968
use module to escape regexp special characters
2014-07-07 16:49:11 -07:00
Jeff Williams
cae3cce8c1
add longnamesToTree method
2014-07-03 13:53:46 -07:00
Jeff Williams
dcca9a4714
clean up constants exported by jsdoc/name
2014-07-03 12:35:56 -07:00
Jeff Williams
abfa24578c
don't log an error when a comment only contains whitespace ( #698 )
2014-07-02 20:11:39 -07:00
Jeff Williams
5c59bc1488
fix a crash (and incorrect output) when a property has its own properties ( #697 )
2014-07-01 19:56:19 -07:00
Jeff Williams
19867a07b0
show mixins for members, not just classes and modules ( #379 )
2014-07-01 16:54:38 -07:00
Jeff Williams
6e940d275b
do not show the default values for enums ( #689 )
2014-07-01 16:34:07 -07:00
