in website/docgen/spec/add-links-spec.js [298:341]
it('should remove extraneous characters from @link links', function() {
// Given a doc with a @link annotation.
var docs = [
{
name: 'webdriver.WebElement',
fileName: 'webdriver',
fileInfo: { filePath: 'selenium-webdriver' },
startingLine: 123
},
{
name: 'element.findElements',
description: 'A promise that {@link webdriver.WebElement()}',
fileName: 'protractor',
fileInfo: { filePath: '' },
startingLine: 3,
returns: {
tagDef: {
name: 'returns',
aliases: ['return'],
canHaveType: true
},
tagName: 'return',
description: 'A promise located {@linkplain webdriver.WebElement Web Elements }.',
startingLine: 119,
typeExpression: 'webdriver.WebElement',
type: {
type: 'NameExpression',
name: 'webdriver.WebElement'
},
typeList: ['webdriver.WebElement']
}
}
];
// When you add links.
addLinks(docs);
// Then ensure a link was added to the type.
expect(docs[1].description).
toBe('A promise that [{@code webdriver.WebElement()}](webdriver.WebElement)');
expect(docs[1].returns.description).
toBe('A promise located [Web Elements](webdriver.WebElement).');
});