Skip to content
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

Jump to bottom

Safe guard against not existing definition when inheriting doc #5561

Merged
merged 4 commits into from
Feb 26, 2020
Merged

Safe guard against not existing definition when inheriting doc #5561

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e8c5a25
Safe guard against not existing definition when inheriting doc
Laniusexcubitor Feb 25, 2020
16c9a17
Log a warning if base documentation cannot be found
Laniusexcubitor Feb 25, 2020
adcfa82
Add source information to warning
Laniusexcubitor Feb 25, 2020
728b50d
Merge branch 'dev' into non-existant-inherit-doc
yufeih Feb 26, 2020
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
9 changes: 8 additions & 1 deletion src/Microsoft.DocAsCode.Metadata.ManagedReference/Resolvers/CopyInheritedDocumentation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,15 @@ private static void Copy(MetadataItem dest, string srcName, ResolverContext cont
if (src == null && !context.Members.TryGetValue(srcName, out src))
{
// Try to resolve any templated references before giving up
if (!context.References.TryGetValue(srcName, out var referenceItem) || !context.Members.TryGetValue(referenceItem.Definition, out src))
if (!context.References.TryGetValue(srcName, out var referenceItem) || referenceItem.Definition == null ||
!context.Members.TryGetValue(referenceItem.Definition, out src))
{
Logger.LogWarning($"Could not resolve base documentation for '{dest.Name}'",
file: dest.Source.Path,
line: dest.Source.StartLine != 0 ? dest.Source.StartLine.ToString() : null);
return;
}

}

Copy(dest, src, context);
Expand Down