Add API documentation for 'MessageService' #8688
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vince-fugnitto
added
documentation
sdirix
force-pushed
the
messageservice-documentation
branch
from
63d26a5
to
7b3c9fc
Compare
Comment on lines
31
to
33
| * The messages are processed by this service and forwarded to an injected {@link MessageClient}. | ||
| * Usually this is the {@link NotificationManager} contributed by "@theia/messages" rendering | ||
| * messages as notifications in the frontend. |
There was a problem hiding this comment.
Do you believe we should reference @theia/messages (a downstream extension) in the parent @theia/core?
There was a problem hiding this comment.
I just wanted to give an example of a MessageClient. I assume that many apps will use the NotificationManager so when someone looks at what the MessageService does they know that their messages end up there. So personally I think it's fine to list it as an example here, but if you prefer I could also remove it again.
There was a problem hiding this comment.
I removed the link and reworded it a bit. If you prefer to remove the mention of "@theia/messages" completely, just let me know :)
Document 'MessageService' and related message interfaces. Signed-off-by: Stefan Dirix <sdirix@eclipsesource.com> Contributed on behalf of STMicroelectronics
sdirix
force-pushed
the
messageservice-documentation
branch
from
7b3c9fc
to
c945385
Compare
vince-fugnitto
approved these changes
Nov 5, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #8687
Signed-off-by: Stefan Dirix sdirix@eclipsesource.com
Contributed on behalf of STMicroelectronics
What it does
Document
MessageServiceand related message interfaces.How to test
Check API doc content and whether the linter reports any formatting errors.
Review checklist
Reminder for reviewers