Treat special property access symbol differently

... when retriving documentation
This commit is contained in:
zhengbli 2016-08-18 17:12:40 -07:00
Родитель f57b0fbb98
Коммит 03dcdda443
2 изменённых файлов: 38 добавлений и 0 удалений

Просмотреть файл

@ -4913,6 +4913,24 @@ namespace ts {
if (!documentation) {
documentation = symbol.getDocumentationComment();
if ((!documentation || documentation.length === 0) && symbol.flags & SymbolFlags.Property) {
// For some special property access expressions like `experts.foo = foo` or `module.exports.foo = foo`
// there documentation comments might be attached to the right hand side symbol of their declarations.
// The pattern of such special property access is that the parent symbol is the symbol of the file.
if (symbol.parent && forEach(symbol.parent.declarations, declaration => declaration.kind === SyntaxKind.SourceFile)) {
forEach(symbol.declarations, declaration => {
if (declaration.parent && declaration.parent.kind === SyntaxKind.BinaryExpression) {
const rhsSymbol = program.getTypeChecker().getSymbolAtLocation((<BinaryExpression>declaration.parent).right);
if (rhsSymbol) {
documentation = rhsSymbol.getDocumentationComment();
if (documentation && documentation.length > 0) {
return true;
}
}
}
});
}
}
}
return { displayParts, documentation, symbolKind };

Просмотреть файл

@ -0,0 +1,20 @@
/// <reference path="../fourslash.ts"/>
// @allowNonTsExtensions: true
// @Filename: a.js
//// /**
//// * Modify the parameter
//// * @param {string} p1
//// */
//// var foo = function (p1) { }
//// exports.foo = foo;
//// fo/*1*/
// @Filename: b.ts
//// import a = require("./a");
//// a.fo/*2*/
goTo.marker('1');
verify.completionEntryDetailIs("foo", "var foo: (p1: string) => void", "Modify the parameter");
goTo.marker('2');
verify.completionEntryDetailIs("foo", "(property) a.foo: (p1: string) => void", "Modify the parameter");