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 in core package #3

Closed
wants to merge 1 commit into from

Conversation

sdirix
Copy link
Member

@sdirix sdirix commented Sep 27, 2020

  • Document 'BackendContribution'
  • Document 'MessageService' and related message interfaces
  • Extend documentation of MenuContribution and related menu interfaces
    and classes
  • Document 'PreferenceService', 'PreferenceProxy' and related
    interfaces, classes and functions

Signed-off-by: Stefan Dirix [email protected]
Contributed on behalf of STMicroelectronics

@sdirix
Copy link
Member Author

sdirix commented Sep 27, 2020

I created only one commit as all of these files are in the core package.

preference-proxy.ts, preference-service.ts, backend-application -> Jonas
menu.ts -> Tobias
message-service.ts, message-service-protocol.ts -> Philip

@JonasHelming Note in preference-service.ts I did not only add documentation but introduced a new type (for documentation purposes) as well as changed one return type which was manually typed. I don't think this should pose any problems but is of course more risky than only adding documentation.

Copy link

@tortmayr tortmayr left a comment

Choose a reason for hiding this comment

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

[Menu] In general great documentation! I added a few inline suggestions/comments

packages/core/src/common/menu.ts Show resolved Hide resolved
packages/core/src/common/menu.ts Outdated Show resolved Hide resolved
packages/core/src/common/menu.ts Outdated Show resolved Hide resolved
packages/core/src/common/menu.ts Outdated Show resolved Hide resolved
packages/core/src/common/menu.ts Show resolved Hide resolved
packages/core/src/common/message-service-protocol.ts Outdated Show resolved Hide resolved
packages/core/src/common/message-service-protocol.ts Outdated Show resolved Hide resolved
packages/core/src/common/message-service.ts Outdated Show resolved Hide resolved
packages/core/src/common/message-service.ts Outdated Show resolved Hide resolved
packages/core/src/common/message-service-protocol.ts Outdated Show resolved Hide resolved
packages/core/src/common/message-service-protocol.ts Outdated Show resolved Hide resolved
packages/core/src/common/message-service-protocol.ts Outdated Show resolved Hide resolved
packages/core/src/browser/preferences/preference-proxy.ts Outdated Show resolved Hide resolved
packages/core/src/common/menu.ts Outdated Show resolved Hide resolved
packages/core/src/node/backend-application.ts Outdated Show resolved Hide resolved
Copy link

@tortmayr tortmayr left a comment

Choose a reason for hiding this comment

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

[Menu] LGTM. 👍

* Document 'BackendContribution'
* Document 'MessageService' and related message interfaces
* Extend documentation of MenuContribution and related menu interfaces
and classes
* Document 'PreferenceService', 'PreferenceProxy' and related
interfaces, classes and functions

Signed-off-by: Stefan Dirix <[email protected]>
Contributed on behalf of STMicroelectronics
@sdirix
Copy link
Member Author

sdirix commented Oct 5, 2020

Reverted the copyright header changes

@planger planger self-requested a review October 7, 2020 07:28
@sdirix
Copy link
Member Author

sdirix commented Oct 9, 2020

Split into #11, #12, #13 and #14

@sdirix sdirix closed this Oct 9, 2020
ndoschek added a commit that referenced this pull request Apr 21, 2023
Contributed on behalf of STMicroelectronics.

Signed-off-by: Nina Doschek <[email protected]>
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.

4 participants