Skip to content

Add documentation for widget manager & open handler#8644

Merged
vince-fugnitto merged 1 commit intoeclipse-theia:masterfrom
eclipsesource:widget-docu
Oct 23, 2020
Merged

Add documentation for widget manager & open handler#8644
vince-fugnitto merged 1 commit intoeclipse-theia:masterfrom
eclipsesource:widget-docu

Conversation

@tortmayr
Copy link
Contributor

FIxes #8643

  • Document 'WidgetManager' and related interfaces
  • Document 'WidgetOpenHandler' and related interfaces

Signed-off-by: Tobias Ortmayr tortmayr@eclipsesource.com
Contributed on behalf of STMicroelectronics

What it does

Adds/refines documentation for WidgetManager and WidgetOpenHandler

How to test

Documentation only

Review checklist

Reminder for reviewers

Copy link
Member

@vince-fugnitto vince-fugnitto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation updates look very good with a few minor comments.

In a previous documentation pull-request I brought up a question regarding the use of {@link}
which unfortunately does not work properly: #8637 (comment).

@vince-fugnitto vince-fugnitto added core issues related to the core of the application documentation issues related to documentation labels Oct 16, 2020
@tortmayr
Copy link
Contributor Author

Thanks for the fast review. I addressed the mentioned issues and only used @link for the first occurrence in the documentation block. (as suggested in #8637 (comment))

Copy link
Member

@vince-fugnitto vince-fugnitto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content looks very good, I have a very minor comment only.

FIxes  eclipse-theia#8643
- Document 'WidgetManager' and related interfaces
- Document 'WidgetOpenHandler' and related interfaces
Signed-off-by: Tobias Ortmayr <tortmayr@eclipsesource.com>
Contributed on behalf of STMicroelectronics
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core issues related to the core of the application documentation issues related to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add documentation for WidgetManager

2 participants