Skip to content

fix: crash on unimplemented when populating overloads destructor entry #922

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
+4 −0
Open

fix: crash on unimplemented when populating overloads destructor entry #922

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions src/lib/Metadata/Finalizers/Javadoc/Overloads.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,10 @@ populateOverloadsFromClass(OverloadsInfo& I)
return true;
}
case FunctionClass::Destructor:
{
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Destructor overloads?

Copy link
Collaborator

@alandefreitas alandefreitas Jul 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't the problem in the calling function?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you accept the logical consistency about having a destructor overload set which can only be a single element.

The resulting adoc looks perfectly reasonable. Maybe we could just rename the brief to 'Destructor' instead of 'Destructors'?

Copy link
Collaborator

@alandefreitas alandefreitas Jul 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. You could be correct in theoretical terms. What I mean is that, in practical terms, as an implementation detail of MrDocs, where an overload set must have at least two members, that code is unreachable. If it's being reached, there's a bug somewhere else we need to fix. Or maybe it should be reachable for some reason I haven't understood yet.

Even if the resulting adoc looks good in terms of what we were able to investigate so far, we still have a problem here, and we have to understand why it's happening and what else it's affecting in the corpus and the output.

I.javadoc->brief = "Destructors";
return true;
}
default:
MRDOCS_UNREACHABLE();
}
Expand Down
Loading