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

Jump to bottom

Display AADLDoc for all elements #2075

Closed
lwrage opened this issue Nov 22, 2019 · 1 comment · Fixed by #2244
Closed

Display AADLDoc for all elements #2075

lwrage opened this issue Nov 22, 2019 · 1 comment · Fixed by #2244
Assignees
@lwrage
Labels
category:enhancement core importance:low
Milestone
2.7.1

Comments

@lwrage
Copy link
Contributor

lwrage commented Nov 22, 2019 •
edited

Summary

When adding AADLDoc comments to a record field there is no documentation shown when hovering over a field name in an AADL model.

Environment

  • OSATE Version: 2.6.0
  • Operating System: all
@lwrage lwrage added this to the 2.7.1 milestone Jan 30, 2020
@lwrage lwrage modified the milestones: 2.7.1, 2.8.0 Mar 6, 2020
@lwrage
Copy link
Contributor Author

lwrage commented Mar 18, 2020 •
edited

Hover text is provided via an IEObjectHoverProvider. The default implementation DefaultEObjectHoverProvider delegates to an IEObjectHoverDocumentationProvider that reads the AADLDoc (comment lines starting with --- immediately preceding the declaration).
DefaultEObjectHoverProvider checks in method if the referenced object can have hover text by checking if the object has a qualified name. We should just allow any NamedElement to have hover text.

@lwrage lwrage assigned lwrage and unassigned joeseibel Mar 18, 2020
@lwrage lwrage modified the milestones: 2.8.0, 2.7.1 Mar 18, 2020
@lwrage lwrage changed the title Display AADLDoc for fields of record properties Display AADLDoc for all elements Mar 18, 2020
@lwrage lwrage mentioned this issue Mar 18, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lwrage lwrage

Labels
category:enhancement core importance:low
Projects
None yet
Milestone
2.7.1
Development

Successfully merging a pull request may close this issue.

Enable AADLDoc hover for all named elements osate/osate2
2 participants
@lwrage @joeseibel