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

Add API documentation for 'PreferenceService' #8612

Conversation

sdirix
Copy link
Member

@sdirix sdirix commented Oct 9, 2020

Summary

Document 'PreferenceService', 'PreferenceProxy' and related interfaces,
classes and functions.

Closes #8611

Signed-off-by: Stefan Dirix sdirix@eclipsesource.com
Contributed on behalf of STMicroelectronics

What it does

  • Add API documentation to 'PreferenceService', 'PreferenceProxy' and more
  • Minor backwards compatible typing adjustments in preference-service.ts for cleanup and documentation purposes.

How to test

  • Check documentation and make sure everything compiles

Review checklist

Reminder for reviewers

@vince-fugnitto vince-fugnitto added the documentation issues related to documentation label Oct 9, 2020
@sdirix sdirix force-pushed the preferenceservice-documentation branch from 71db7aa to 90aa820 Compare October 9, 2020 14:57
Document 'PreferenceService', 'PreferenceProxy' and related interfaces,
classes and functions.

Signed-off-by: Stefan Dirix <sdirix@eclipsesource.com>
Contributed on behalf of STMicroelectronics
@sdirix sdirix force-pushed the preferenceservice-documentation branch from 90aa820 to 1bcaf14 Compare October 12, 2020 06:15
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 changes look very good!
Thank you for the contribution @sdirix 👍

@vince-fugnitto vince-fugnitto added core issues related to the core of the application preferences issues related to preferences labels Oct 22, 2020
@vince-fugnitto vince-fugnitto merged commit 12a8563 into eclipse-theia:master Oct 22, 2020
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 preferences issues related to preferences
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Documentation for 'PreferenceService' and 'PreferenceProxy'
2 participants