in website/docgen/spec/add-links-spec.js [254:296]
it('should handle "#" in @link links', function() {
// Given a doc with a @link annotation.
var docs = [
{
name: 'webdriver.WebDriver',
fileName: 'webdriver',
fileInfo: { filePath: 'selenium-webdriver' },
startingLine: 123
},
{
name: 'webdriver.WebElement',
description: 'A promise that {@link #WebDriver Web Drivers}',
fileName: 'webdriver',
fileInfo: { filePath: 'selenium-webdriver' },
startingLine: 3,
returns: {
tagDef: {
name: 'returns',
aliases: ['return'],
canHaveType: true
},
tagName: 'return',
description: 'A promise located {@link 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 Web Drivers}](webdriver.WebDriver)');
expect(docs[1].returns.description).
toBe('A promise located {@code Web Elements}.');
});