Skip to content

Declare local variables for the 'href' field, to promote and avoid printing 'null' #3788

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
merged 2 commits into from
Jun 18, 2024
Merged

Declare local variables for the 'href' field, to promote and avoid printing 'null' #3788

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
4631023
Declare local variables for the 'href' field, to promote and avoid pr…
srawlins Jun 17, 2024
bb7eb05
patterns
srawlins Jun 18, 2024
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
7 changes: 2 additions & 5 deletions lib/src/markdown_processor.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,15 +314,12 @@ class MarkdownDocument extends md.Document {
var textContent = _htmlEscape.convert(referenceText);
var linkedElement = result.commentReferable;
if (linkedElement != null) {
if (linkedElement.href != null) {
if (linkedElement.href case var href?) {
var anchor = md.Element.text('a', textContent);
if (linkedElement is ModelElement && linkedElement.isDeprecated) {
anchor.attributes['class'] = 'deprecated';
}
var href = linkedElement.href;
if (href != null) {
anchor.attributes['href'] = href;
}
anchor.attributes['href'] = href;
return anchor;
} else {
// Otherwise this would be `linkedElement.linkedName`, but link bodies
Expand Down
5 changes: 5 additions & 0 deletions lib/src/model/category.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,11 @@ class Category
String get linkedName {
final unbrokenName = name.replaceAll(' ', ' ');
if (isDocumented) {
final href = this.href;
if (href == null) {
throw StateError("Requesting the 'linkedName' of a non-canonical "
"category: '$name'");
}
return '<a href="$href">$unbrokenName</a>';
} else {
return unbrokenName;
Expand Down
1 change: 1 addition & 0 deletions lib/src/model/model_element.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -687,6 +687,7 @@ abstract class ModelElement
element.kind == ElementKind.NEVER ||
this is ModelFunction);

final href = this.href;
if (href == null) {
if (isPublicAndPackageDocumented) {
warn(PackageWarning.noCanonicalFound);
Expand Down