Skip to content

Add support for class param declarations at the constructor #1013

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Feb 10, 2018
Merged

Add support for class param declarations at the constructor #1013

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/infer/params.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,11 @@ function inferParams(comment: Comment) {

function inferAndCombineParams(params, comment) {
const inferredParams = params.map((param, i) => paramToDoc(param, '', i));
const mergedParamsAndErrors = mergeTrees(inferredParams, comment.params);
const paramsToMerge = comment.params;
if (comment.constructorComment) {
paramsToMerge.push.apply(paramsToMerge, comment.constructorComment.params);
}
const mergedParamsAndErrors = mergeTrees(inferredParams, paramsToMerge);

// Then merge the trees. This is the hard part.
return Object.assign(comment, {
Expand Down
2 changes: 1 addition & 1 deletion src/parsers/javascript.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ function _addComment(

if (t.isClassMethod(path) && path.node.kind === 'constructor') {
// #689
if (!comment.hideconstructor) {
if (comment.tags.some(tag => tag.title !== 'param' && tag.title !== 'hideconstructor')) {
debuglog(
'A constructor was documented explicitly: document along with the class instead'
);
Expand Down