Skip to content

fix(xmldocs): over-greedy regex for Markdown links #5798

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
avodovnik merged 2 commits into from
Mar 11, 2021
Merged

fix(xmldocs): over-greedy regex for Markdown links #5798

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0fa1da2
fix(xmldocs): over-greedy regex for Markdown links
avodovnik Mar 11, 2021
1f942e3
fix(dotnet): missing using and extra spaces
avodovnik Mar 11, 2021
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
2 changes: 1 addition & 1 deletion utils/doclint/generateDotnetApi.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ function generateEnumNameIfApplicable(member, name, type, parent) {
function renderMethod(member, parent, output, name) {
const typeResolve = (type) => translateType(type, parent, (t) => {
let newName = `${parent.name}${translateMemberName(member.kind, member.name, null)}Result`;
documentedResults.set(newName, `Result of calling <see cref="${translateMemberName("interface", parent.name)}.${translateMemberName(member.kind, member.name, member)}" />.`);
documentedResults.set(newName, `Result of calling <see cref="${translateMemberName("interface", parent.name)}.${translateMemberName(member.kind, member.name, member)}"/>.`);
return newName;
});

Expand Down
1 change: 1 addition & 0 deletions utils/doclint/templates/interface.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
using System.IO;
using System.Runtime.Serialization;
using System.Text.Json;
using System.Text.Json.Serialization;
using System.Text.RegularExpressions;
using System.Threading;
using System.Threading.Tasks;
Expand Down
6 changes: 3 additions & 3 deletions utils/doclint/xmlDocumentation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,11 +118,11 @@ function _wrapAndEscape(node, maxColumns = 0) {


let text = node.text;
text = text.replace(/`([^`]*)`/g, (match, code) => `<c>${code.replace('<', '&lt;').replace('>', '&gt;')}</c>`);
text = text.replace(/\[(.*?)\]\((.*?\))/g, (match, linkName, linkUrl) => {
text = text.replace(/\[(.*?)\]\((.*?)\)/g, (match, linkName, linkUrl) => {
return `<a href="${linkUrl}">${linkName}</a>`;
});
text = text.replace(/\[(.*?)\]/g, (match, link) => `<see cref="${link}" />`);
text = text.replace(/(?<!`)\[(.*?)\]/g, (match, link) => `<see cref="${link}"/>`);
text = text.replace(/`([^`]*)`/g, (match, code) => `<c>${code.replace('<', '&lt;').replace('>', '&gt;')}</c>`);
const words = text.split(' ');
let line = '';
for (let i = 0; i < words.length; i++) {
Expand Down