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.
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@linkcommand in Doxygen is different than in JSDoc and expects a corresponding@endlinktag. 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.