llvm / clangd-www

Apache License 2.0
27 stars 53 forks source link

Add documentation to semantic token config #85

Closed daiyousei-qz closed 12 months ago

daiyousei-qz commented 1 year ago

This is documentation for configuration added by https://reviews.llvm.org/D148489.

From a maintainability point of view, I think the complete list of kinds/modifiers should be added to "features.md". What do you think? @HighCommander4

HighCommander4 commented 1 year ago

From a maintainability point of view, I think the complete list of kinds/modifiers should be added to "features.md". What do you think? @HighCommander4

Agree, that would be nice! And, especially for kinds/modifiers which are not part of the standard ones listed in LSP, a short description would also be very useful.

HighCommander4 commented 1 year ago

@daiyousei-qz A friendly reminder about this PR. LLVM 17 (the version in which the new configs will ship) has branched and will be released in about 5-6 weeks.

daiyousei-qz commented 1 year ago

Sorry for the long absence. I've updated features.md and added a section of semantic highlighting, including a few tables discussing available kinds/modifiers. The available version was read from the git submit date of the enum and I picked a release that's at least a month away. I don't check with different versions of clangd. As the pick is conservative, some items may be available one version earlier.

The deployment of the website in README isn't very friendly to Windows user. Could you please help me ensure that table is well formatted in the website? Thanks!

daiyousei-qz commented 1 year ago

@HighCommander4 Do you want me to also squash the commits into one?