Bug fix/csharp signature generation #63
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
omckeon
added a commit
to splashkit/splashkit.io-starlight
that referenced
this pull request
Dec 9, 2024
macite
reviewed
Jan 6, 2025
macite
force-pushed
the
bug-fix/csharp-signature-generation
branch
from
761f67d to
48eb65d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The translator was generating incorrect instance names by using :name instead of :method_name, leading to invalid or non-existent function signatures. Additionally, some functions had null values for method_name because they didnt have an instance version, meaning docs_signatures_for was generating instances that didnt exist as well as incorrect instance signatures.
Changes
Switching to :method_name and adding a null check to skip non-existing instance functions resolved the problem.
How has this been tested?
ran docker-compose run --rm headerdoc docs and it generated the correct api.json data with the correct instance signatures