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.

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

[BUG] @note tag not showing in generated documentation #29

Open
F1F88 opened this issue Dec 17, 2024 · 0 comments
Open

[BUG] @note tag not showing in generated documentation #29

F1F88 opened this issue Dec 17, 2024 · 0 comments

Comments

@F1F88
Copy link

F1F88 commented Dec 17, 2024

The@note tag was not correctly displayed in the generated documentation.This caused the additional comment information provided in the code to be lost, which may affect the integrity of the documentation.

Example:

The CloseHandle source code: https://github.com/alliedmodders/sourcemod/blob/master/plugins/include/handles.inc#L51

Expected Behavior:

The content of the @note tag should be displayed correctly, for example: https://sm.alliedmods.net/new-api/handles/CloseHandle

Actual behavior:
The currently generated documentation does not show any @note related information: https://sourcemod.dev/#/handles/function.CloseHandle

I'm sorry that due to my personal limitations, I can't directly submit a PR to fix this issue for the time being, but I'm very willing to test or provide more help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant