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

New documentation support #203

Draft
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

i582
Copy link
Contributor

@i582 i582 commented Oct 18, 2024

Note: this PR is not ready for review yet, only for discussion of changes in support documentation in general.
Note2: until #199 is merged, this PR also contains code from it

In this PR we use the new documentation API: https://plugins.jetbrains.com/docs/intellij/documentation.html#documentation-target-api

This PR supports following symbols:

  • Functions
    • Attributes
    • Public/Native/Entry modifiers
    • Type parameters
    • Acquires (WIP)
    • Highlight usage of type parameters in signature
  • Modules
  • Structs
    • Attributes
    • Type parameters
    • Abilities
  • Named fields
    • Attributes
  • Enums
    • Attributes
    • Type parameters
  • Enum variants (both with block fields and positional)
    • Attributes
    • Documentation from comments
  • Constants
    • Attributes
  • Schemas
    • Type parameters
  • Named addresses
    • Documentation from inline comments in TOML

This PR introduces color highlighting for all signatures:

Big things to do

  • Tests
  • Cleanup
  • Documentation with ctrl-hover

Fixes #202

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.

Documentation support issues
1 participant