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 command intellisense support #211

Merged
merged 8 commits into from
Apr 14, 2021
Merged

Doxygen command intellisense support #211

merged 8 commits into from
Apr 14, 2021

Conversation

HO-COOH
Copy link
Contributor

@HO-COOH HO-COOH commented Mar 30, 2021

Fix/Feature/Other

Fix

Feature

  • [√] Description of what's added

It can trigger the auto complete after typing either @ or \ and will have a placeholder as the argument to the doxygen command. Some doxygen commands need to be paired with an ending command, and it will also be auto completed in the snippet.

Currently it looks like this:
Effect

However I don't know why vscode doesn't automatically add the leading * for block comment and format it like it does in javascript/typescript, like this:
Correct

In C++ it looks like this:
Wrong

I might messed up some settings in the C++ formatter, but please let me know if it's the same behavior on your machine.
This is a bug of the C/C++ extension, which was resolved. Tracked in here

@codecov
Copy link

codecov bot commented Mar 30, 2021

Codecov Report

Merging #211 (9d05d9b) into master (c8c7918) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #211   +/-   ##
=======================================
  Coverage   93.34%   93.34%           
=======================================
  Files           5        5           
  Lines         842      842           
  Branches      240      240           
=======================================
  Hits          786      786           
  Misses         56       56           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c8c7918...9d05d9b. Read the comment docs.

@HO-COOH HO-COOH marked this pull request as draft March 30, 2021 14:02
@HO-COOH
Copy link
Contributor Author

HO-COOH commented Apr 3, 2021

Update: Now it is almost there, see gif. I will make the documentation to proper markdown string

dox

I haven't checked out how to use the automated testing, but please give me feedback.

@HO-COOH HO-COOH marked this pull request as ready for review April 3, 2021 17:33
@HO-COOH HO-COOH changed the title WIP: Initial doxygen command intellisense support Doxygen command intellisense support Apr 3, 2021
@HO-COOH
Copy link
Contributor Author

HO-COOH commented Apr 3, 2021

All done, ready to be merged!
doxygen-auto-complete

@cschlosser
Copy link
Owner

Sorry I missed you removing the WIP indicator. Great work, thank you for contributing!

@cschlosser cschlosser merged commit a9fb66b into cschlosser:master Apr 14, 2021
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

Successfully merging this pull request may close these issues.

None yet

2 participants