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

Doxygen multi-whitespace parsing regression #12015

Closed
alexandruavadanii opened this issue Feb 25, 2024 · 2 comments
Closed

Doxygen multi-whitespace parsing regression #12015

alexandruavadanii opened this issue Feb 25, 2024 · 2 comments
Assignees
Labels
bug Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. fixed Check the Milestone for the release in which the fix is or will be available. Language Service quick fix regression A bug that didn't exist in a previous release
Milestone

Comments

@alexandruavadanii
Copy link

alexandruavadanii commented Feb 25, 2024

Type: Bug

Before v1.19.4 (up to and including v1.19.3 sorry, I mixed up the versions, apparently it was already broken in v1.19.x, but it works fine in v1.18.5), both Doxygen comments for these 2 functions were parsed correctly:

/**
 * @fn cpptools_test1
 * @brief desc for this void func
 * 
 * @param p1   some pointer
 * @param p2   some other pointer
 */
static void
cpptools_test1(void *p1, void *p2)
{
   (void)p1;
   (void)p2;
}

/**
 * @fn cpptools_test2
 * @brief      desc for this void func
 * 
 * @param  p1  some pointer
 * @param  p2  some other pointer
 */
static void
cpptools_test2(void *p1, void *p2)
{
   (void)p1;
   (void)p2;
}

Starting with v1.19.4, the comment for cpptools_test1 is parsed correctly, but cpptools_test2 (which has 2 or more spaces after the Doxygen keywords) is broken - note the coalescing of the parameter name with its description, as well as keyword highlighting in the function description. Looks like the @fn keyword works with 1...4 spaces, but not more.

image

image

Extension version: 1.19.4
VS Code version: Code - Insiders 1.87.0-insider (c11a2dd4d52e38cb92b8c464f47a7b02bb7c8762, 2024-02-24T01:20:40.384Z)
OS version: Windows_NT x64 10.0.18362
Modes:
Remote OS version: Linux x64 4.18.0-372.19.1.el8_6.x86_64

System Info
Item Value
CPUs Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz (8 x 2112)
GPU Status 2d_canvas: enabled
canvas_oop_rasterization: enabled_on
direct_rendering_display_compositor: disabled_off_ok
gpu_compositing: enabled
multiple_raster_threads: enabled_on
opengl: enabled_on
rasterization: enabled
raw_draw: disabled_off_ok
skia_graphite: disabled_off
video_decode: enabled
video_encode: enabled
vulkan: disabled_off
webgl: enabled
webgl2: enabled
webgpu: enabled
Load (avg) undefined
Memory (System) 15.81GB (8.16GB free)
Process Argv
Screen Reader no
VM 0%
Item Value
Remote SSH: sestolabccv8
OS Linux x64 4.18.0-372.19.1.el8_6.x86_64
CPUs Intel(R) Xeon(R) Silver 4216 CPU @ 2.10GHz (8 x 2095)
Memory (System) 31.21GB (17.83GB free)
VM 100%
Item Value
Remote SSH: sestolabccv8
OS Linux x64 4.18.0-372.19.1.el8_6.x86_64
CPUs Intel(R) Xeon(R) Silver 4216 CPU @ 2.10GHz (8 x 2095)
Memory (System) 31.21GB (17.83GB free)
VM 100%
@alexandruavadanii alexandruavadanii changed the title Doxygen multi-whitespace parsing regression in 1.19.4 Doxygen multi-whitespace parsing regression Feb 25, 2024
@sean-mcmanus sean-mcmanus added bug Language Service Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. regression A bug that didn't exist in a previous release labels Feb 26, 2024
@sean-mcmanus sean-mcmanus self-assigned this Feb 26, 2024
@sean-mcmanus sean-mcmanus added this to the 1.20 milestone Feb 26, 2024
@bobbrow bobbrow modified the milestones: 1.20, 1.19.5 Feb 27, 2024
@sean-mcmanus sean-mcmanus added the fixed Check the Milestone for the release in which the fix is or will be available. label Feb 28, 2024
@sean-mcmanus
Copy link
Collaborator

@alexandruavadanii
Copy link
Author

@sean-mcmanus Verified, all ok, thank you!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. fixed Check the Milestone for the release in which the fix is or will be available. Language Service quick fix regression A bug that didn't exist in a previous release
Projects
None yet
Development

No branches or pull requests

4 participants