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

Use Doxygen's \ref syntax instead of JSDoc's {@link} #800

Open
azrogers opened this issue Jan 31, 2024 · 0 comments
Open

Use Doxygen's \ref syntax instead of JSDoc's {@link} #800

azrogers opened this issue Jan 31, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers quality Improve code quality or encourage developer success

Comments

@azrogers
Copy link
Contributor

azrogers commented Jan 31, 2024

Throughout cesium-native, we currently use {@link TypeName} to represent a reference to another documented type or function. The problem with this syntax is that it's not Doxygen's syntax - it's JSDoc's, imported from CesiumJS. While Doxygen can interpret commands that start with @, the @link command in Doxygen is different than in JSDoc and expects a corresponding @endlink tag. This seems to currently work with Doxygen, the generated docs seem to handle the JSDoc tag just fine, it completely breaks Visual Studio's Intellisense, which will stop parsing the doc comment at the first @link.

We should instead use \ref, which is the equivalent to JSDoc's {@link}. This can likely be accomplished with a Regex find-and-replace, but should be done over the entire project at once.

@j9liu j9liu added good first issue Good for newcomers quality Improve code quality or encourage developer success labels Feb 21, 2024
@j9liu j9liu added the documentation Improvements or additions to documentation label Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers quality Improve code quality or encourage developer success
Projects
None yet
Development

No branches or pull requests

2 participants