-
Notifications
You must be signed in to change notification settings - Fork 253
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
[documentation]: refactor documentation #7610
Labels
documentation
This issue is about wrong documentation
enhancement
New feature or request
TOPIC B
TOPIC Core
TOPIC P
TOPIC RD
TOPIC RL
Comments
nnaydenow
added
TOPIC P
TOPIC RL
TOPIC RD
TOPIC B
TOPIC Core
enhancement
New feature or request
documentation
This issue is about wrong documentation
labels
Sep 20, 2023
Internal BLI was created: FIORITECHP1-28822 |
This was referenced Oct 26, 2023
s-todorova
added a commit
that referenced
this issue
Oct 29, 2023
JSDoc changes related to using the new custom-elements-manifest for Rodopi-owned components. Issue: #7610
s-todorova
added a commit
that referenced
this issue
Oct 31, 2023
JSDoc changes related to using the new custom-elements-manifest for Rodopi-owned components. Issue: #7610
plamenivanov91
added a commit
to plamenivanov91/ui5-webcomponents
that referenced
this issue
Nov 7, 2023
This was referenced Nov 15, 2023
plamenivanov91
added a commit
that referenced
this issue
Nov 15, 2023
s-todorova
added a commit
that referenced
this issue
Nov 16, 2023
s-todorova
added a commit
that referenced
this issue
Nov 20, 2023
nnaydenow
pushed a commit
that referenced
this issue
Nov 21, 2023
* docs: new cem for Topic-P components - Icon Issue: #7610 * docs: new cem for Topic-P components - Icon -fixed review comments * docs: new cem for Topic-P components - Icon -ignored lint error * fix(ui5-wizard): scrollbar styles are now present on root (#7838) * docs: new cem for Topic-P components - Icon -removed @INTERACE jsdoc tag from interfaces file --------- Co-authored-by: Ivaylo Plashkov <ivaylo.plashkov@sap.com>
nnaydenow
added a commit
that referenced
this issue
Nov 21, 2023
* docs: new cem for Topic-P components - ShellBar Issue: #7610 * docs: new cem for Topic-P components - ShellBar - fixed review comments * fix(ui5-wizard): scrollbar styles are now present on root (#7838) * docs: new cem for Topic-P components - ShellBar - fixed review comments * chore: update chromedriver to 119 (#7883) * fix(ui5-switch): align 'off' text in RTL, add compact mode params (#7603) In RTL mode the 'off' icon of `Graphical` type Switch was misaligned due to missing parameters for RTL scenario of the control. Fixes: #7522 Fixes: #7806 * fix(framework): redundant fonts loading (#7868) fix(framework): font loading Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com> * docs: new cem for Topic-P components - ShellBar - fixed review comments --------- Co-authored-by: Ivaylo Plashkov <ivaylo.plashkov@sap.com> Co-authored-by: ilhan orhan <ilhan.orhan007@gmail.com> Co-authored-by: Stoyan <88034608+hinzzx@users.noreply.github.com> Co-authored-by: Nayden Naydenov <31909318+nnaydenow@users.noreply.github.com> Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com>
s-todorova
added a commit
that referenced
this issue
Nov 22, 2023
s-todorova
added a commit
that referenced
this issue
Nov 23, 2023
s-todorova
added a commit
that referenced
this issue
Nov 27, 2023
nnaydenow
pushed a commit
that referenced
this issue
Nov 28, 2023
* docs: new cem for Topic-P components - Toolbar Issue: #7610 * docs: new cem for Topic-P components - Toolbar -refactored toolbar related files docs * docs: new cem for Topic-P components - Toolbar - removed unnecessary tag rom ToolbarSeparator docs * docs: new cem for Topic-P components - Toolbar -fixed review comments * docs: new cem for Topic-P components - Toolbar - fixed review comments * docs: new cem for Topic-P components - Toolbar - fixed review comments * docs: new cem for Topic-P components - Toolbar - fixed review comments * docs: new cem for Topic-P components - Toolbar - fixed review comments * docs: new cem for Topic-P components - Toolbar - fixed review comments
nnaydenow
pushed a commit
that referenced
this issue
Nov 28, 2023
* docs: new cem for Topic-P components - List Issue: #7610 * docs: new cem for Topic-P components - List - fixed review comments * docs: new cem for Topic-P components - List - fixed review comments * docs: new cem for Topic-P components - List - fixed review comments * docs: new cem for Topic-P components - List - fixed review comments
plamenivanov91
added a commit
to plamenivanov91/ui5-webcomponents
that referenced
this issue
Nov 28, 2023
s-todorova
added a commit
that referenced
this issue
Nov 29, 2023
nnaydenow
added a commit
that referenced
this issue
Nov 29, 2023
* fix(ui5-textarea): adjust scroll positioning (#7920) * docs(ui5-select-menu-option): correct disabled property description (#7925) docs(ui5-select-menu-option): correct docs Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com> * docs: new cem for Topic-P components - Tree Issue: #7610 * docs: new cem for Topic-P components - Tree -fixed review comments --------- Co-authored-by: niyap <38278268+niyap@users.noreply.github.com> Co-authored-by: Nayden Naydenov <31909318+nnaydenow@users.noreply.github.com> Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com>
nnaydenow
pushed a commit
that referenced
this issue
Nov 30, 2023
* docs: new cem for Topic-RD components JSDoc changes related to using the new custom-elements-manifest for Rodopi-owned components. Issue: #7610 * docs: remove types from enums * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 * chore: fulfill * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 --------- Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com>
nnaydenow
added a commit
that referenced
this issue
Jan 10, 2024
* docs: generate cem * chore: cleanup * chore: migrate button * chore: generate manifest for base * chore: cleanup * chore: enhance * chore: align storybook to use cem * chore: 09/10 * chore: 10.10 * chore: add validator for manifest * chore: add valid jsdoc tags * chore: improve validators * chore: migrate samples prepare to storybook * chore: ts * chore: fix missing tags * chore: clean * chore: correct deps * chore: fix scripts * chore: validate tags * chore: optional execution of script * chore: sampels docs * chore: restore previous scripts and enable cem for base * chore: fix validation of @default * chore: fix storybook build * chore: fix schema and add missing tags * chore: restore bundle * chore: add param type * chore: generate new manifest * fix: chore description * fix: param / unnamed slots privacy * chore: show css parts * chore: extract storybook * chore: restore nps script * chore: restore component migration * fix: default value * fix: enum schema validation * fix: show interfaces * fix: ts files path * chore: refacotor, fix validation, add internal json * chore: update schema and validation * chore: add yarnlock * chore: fix event param types * fix: show event params * fix: display only public ones * chore: restore input paths * chore: refactor * chore: update schema * chore: restore paths * chore: add override for getters, methods, props * docs: new cem for Topic-P components - Icon (#7810) * docs: new cem for Topic-P components - Icon Issue: #7610 * docs: new cem for Topic-P components - Icon -fixed review comments * docs: new cem for Topic-P components - Icon -ignored lint error * fix(ui5-wizard): scrollbar styles are now present on root (#7838) * docs: new cem for Topic-P components - Icon -removed @INTERACE jsdoc tag from interfaces file --------- Co-authored-by: Ivaylo Plashkov <ivaylo.plashkov@sap.com> * docs: new cem for Topic-P components - ShellBar (#7823) * docs: new cem for Topic-P components - ShellBar Issue: #7610 * docs: new cem for Topic-P components - ShellBar - fixed review comments * fix(ui5-wizard): scrollbar styles are now present on root (#7838) * docs: new cem for Topic-P components - ShellBar - fixed review comments * chore: update chromedriver to 119 (#7883) * fix(ui5-switch): align 'off' text in RTL, add compact mode params (#7603) In RTL mode the 'off' icon of `Graphical` type Switch was misaligned due to missing parameters for RTL scenario of the control. Fixes: #7522 Fixes: #7806 * fix(framework): redundant fonts loading (#7868) fix(framework): font loading Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com> * docs: new cem for Topic-P components - ShellBar - fixed review comments --------- Co-authored-by: Ivaylo Plashkov <ivaylo.plashkov@sap.com> Co-authored-by: ilhan orhan <ilhan.orhan007@gmail.com> Co-authored-by: Stoyan <88034608+hinzzx@users.noreply.github.com> Co-authored-by: Nayden Naydenov <31909318+nnaydenow@users.noreply.github.com> Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com> * chore: add privacy for shellbar events * chore: ehnance validator * chore: add storybook * chore: migrate base package * chore: add correct export definition * docs(ui5-rating-indicator): improve documentation (#7915) * docs(ui5-textarea): improve documentation (#7913) * fix(ui5-textarea): improve documentation * docs(ui5-textarea): reflect comments * chore: fix some components values and make storybook to work * docs(ui5-slider, ui5-range-slider): enhance documentation (#7910) * fix(ui5-slider, ui5-range-slider): enhance documentation * docs(ui5-slider, ui5-range-slider): reflect review comments * chore: cleanup * docs: new cem for Topic-P components - Toolbar (#7814) * docs: new cem for Topic-P components - Toolbar Issue: #7610 * docs: new cem for Topic-P components - Toolbar -refactored toolbar related files docs * docs: new cem for Topic-P components - Toolbar - removed unnecessary tag rom ToolbarSeparator docs * docs: new cem for Topic-P components - Toolbar -fixed review comments * docs: new cem for Topic-P components - Toolbar - fixed review comments * docs: new cem for Topic-P components - Toolbar - fixed review comments * docs: new cem for Topic-P components - Toolbar - fixed review comments * docs: new cem for Topic-P components - Toolbar - fixed review comments * docs: new cem for Topic-P components - Toolbar - fixed review comments * docs: new cem for Topic-P components - List (#7824) * docs: new cem for Topic-P components - List Issue: #7610 * docs: new cem for Topic-P components - List - fixed review comments * docs: new cem for Topic-P components - List - fixed review comments * docs: new cem for Topic-P components - List - fixed review comments * docs: new cem for Topic-P components - List - fixed review comments * chore: fulfill list * docs(ui5-message-strip): improve documentation (#7917) * docs(ui5-message-strip): improve documentation * docs(ui5-message-strip): reflect review comments * docs(ui5-toast): improve documentation (#7914) * docs(ui5-toast): improve documentation * docs(ui5-toast): reflect review comments * docs: new cem for Topic-P components (#7851) * docs: new cem for Topic-P components (#7850) * docs: new cem for Topic-P components - ui5-select * docs: new cem for Topic-P components - ui5-select * docs: new cem for Topic-P components * docs: new cem for Topic-P components --------- Co-authored-by: Nayden Naydenov <31909318+nnaydenow@users.noreply.github.com> * chore: fulfill * docs: new cem for Topic-P components - Tree (#7927) * fix(ui5-textarea): adjust scroll positioning (#7920) * docs(ui5-select-menu-option): correct disabled property description (#7925) docs(ui5-select-menu-option): correct docs Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com> * docs: new cem for Topic-P components - Tree Issue: #7610 * docs: new cem for Topic-P components - Tree -fixed review comments --------- Co-authored-by: niyap <38278268+niyap@users.noreply.github.com> Co-authored-by: Nayden Naydenov <31909318+nnaydenow@users.noreply.github.com> Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com> * chore: fullfill * docs(ui5-panel): improve documentation (#7924) * docs(ui5-panel): improve documentation * docs(ui5-panel): reflect review comments * docs(ui5-panel): reflect review comments * docs(ui5-page): improve documentation (#7919) * docs: rewrite JSDoc for custom-elements-manifest/analyzer (#7778) * docs: new cem for Topic-RD components JSDoc changes related to using the new custom-elements-manifest for Rodopi-owned components. Issue: #7610 * docs: remove types from enums * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 * chore: fulfill * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 --------- Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com> * chore: ts build * docs: Adapt JSDocs for new CЕM and Remove Redundancies (#7922) * docs: Adapt JSDocs for new CЕM and Remove Redundancies * docs: fix merge conflict * docs: adapt docs to updated specs * docs: fix storybook errors * docs: add missing file * docs: update interfaces * docs: fix comments * docs: fix more comments * docs: another comments fix * docs: fix more comments * docs: fix comments * docs: fix ITtimelineItem interface properties --------- Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com> * docs(ui5-wizard): improve documentation (#7935) * docs(ui5-wizard): improve documentation * docs(ui5-wizard): reflect review comments * docs(ui5-combobox): improve documentation (#7942) * chore: execute package script * chore: extract type of parameters with default and enhace storybook * docs(ui5-multi-combobox): improve documentation (#7944) * chore: fix missed files * chore: fixes * chore: fix superclass references * chore: fix paths * chore: align exports with modules name * chore: fix datepicker * chore: add _ui5validator * docs(ui5-table): improve documentation (#7951) * docs(ui5-table): improve documentation * docs(ui5-table): reflect review comments --------- Co-authored-by: Nia Peeva <niya.peeva@sap.com> * docs(ui5-input, ui5-multi-input): improve documentation (#7969) Co-authored-by: Nia Peeva <niya.peeva@sap.com> * chore: fixes * chore: update schema * chore: handle non metadata props * chore: fix select * fix tree * fix tree items * fix tree * review comments * chore: aling interfaces * cleanup interfaces * chore: tab container * chor: tab container interface * chore: return type of color palette popover * chore: fix tree test * escaped new lines * remove parts * optimizations * chore: fix pathds * chore: make some components private * fix schema validation and cleanup * ehance customElement decorator * customElement decorator * fix globs pattern * makr correctly custom elements * corrections * chore: 2 interfaces added * chore: 2 more fixes * chore: fix label and token * chore: do not sort props --------- Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com> Co-authored-by: Vladislav Tasev <vladislav.tasev@sap.com> Co-authored-by: Plamen Ivanov <plamen.ivanov01@sap.com> Co-authored-by: Ivaylo Plashkov <ivaylo.plashkov@sap.com> Co-authored-by: ilhan orhan <ilhan.orhan007@gmail.com> Co-authored-by: Stoyan <88034608+hinzzx@users.noreply.github.com> Co-authored-by: niyap <38278268+niyap@users.noreply.github.com> Co-authored-by: yanaminkova <32466553+yanaminkova@users.noreply.github.com> Co-authored-by: Siyana Todorova <72251110+s-todorova@users.noreply.github.com> Co-authored-by: Nikolay Hristov <n.hristov@sap.com> Co-authored-by: Nia Peeva <niya.peeva@sap.com>
PetyaMarkovaBogdanova
pushed a commit
that referenced
this issue
Jan 17, 2024
* docs: generate cem * chore: cleanup * chore: migrate button * chore: generate manifest for base * chore: cleanup * chore: enhance * chore: align storybook to use cem * chore: 09/10 * chore: 10.10 * chore: add validator for manifest * chore: add valid jsdoc tags * chore: improve validators * chore: migrate samples prepare to storybook * chore: ts * chore: fix missing tags * chore: clean * chore: correct deps * chore: fix scripts * chore: validate tags * chore: optional execution of script * chore: sampels docs * chore: restore previous scripts and enable cem for base * chore: fix validation of @default * chore: fix storybook build * chore: fix schema and add missing tags * chore: restore bundle * chore: add param type * chore: generate new manifest * fix: chore description * fix: param / unnamed slots privacy * chore: show css parts * chore: extract storybook * chore: restore nps script * chore: restore component migration * fix: default value * fix: enum schema validation * fix: show interfaces * fix: ts files path * chore: refacotor, fix validation, add internal json * chore: update schema and validation * chore: add yarnlock * chore: fix event param types * fix: show event params * fix: display only public ones * chore: restore input paths * chore: refactor * chore: update schema * chore: restore paths * chore: add override for getters, methods, props * docs: new cem for Topic-P components - Icon (#7810) * docs: new cem for Topic-P components - Icon Issue: #7610 * docs: new cem for Topic-P components - Icon -fixed review comments * docs: new cem for Topic-P components - Icon -ignored lint error * fix(ui5-wizard): scrollbar styles are now present on root (#7838) * docs: new cem for Topic-P components - Icon -removed @INTERACE jsdoc tag from interfaces file --------- Co-authored-by: Ivaylo Plashkov <ivaylo.plashkov@sap.com> * docs: new cem for Topic-P components - ShellBar (#7823) * docs: new cem for Topic-P components - ShellBar Issue: #7610 * docs: new cem for Topic-P components - ShellBar - fixed review comments * fix(ui5-wizard): scrollbar styles are now present on root (#7838) * docs: new cem for Topic-P components - ShellBar - fixed review comments * chore: update chromedriver to 119 (#7883) * fix(ui5-switch): align 'off' text in RTL, add compact mode params (#7603) In RTL mode the 'off' icon of `Graphical` type Switch was misaligned due to missing parameters for RTL scenario of the control. Fixes: #7522 Fixes: #7806 * fix(framework): redundant fonts loading (#7868) fix(framework): font loading Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com> * docs: new cem for Topic-P components - ShellBar - fixed review comments --------- Co-authored-by: Ivaylo Plashkov <ivaylo.plashkov@sap.com> Co-authored-by: ilhan orhan <ilhan.orhan007@gmail.com> Co-authored-by: Stoyan <88034608+hinzzx@users.noreply.github.com> Co-authored-by: Nayden Naydenov <31909318+nnaydenow@users.noreply.github.com> Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com> * chore: add privacy for shellbar events * chore: ehnance validator * chore: add storybook * chore: migrate base package * chore: add correct export definition * docs(ui5-rating-indicator): improve documentation (#7915) * docs(ui5-textarea): improve documentation (#7913) * fix(ui5-textarea): improve documentation * docs(ui5-textarea): reflect comments * chore: fix some components values and make storybook to work * docs(ui5-slider, ui5-range-slider): enhance documentation (#7910) * fix(ui5-slider, ui5-range-slider): enhance documentation * docs(ui5-slider, ui5-range-slider): reflect review comments * chore: cleanup * docs: new cem for Topic-P components - Toolbar (#7814) * docs: new cem for Topic-P components - Toolbar Issue: #7610 * docs: new cem for Topic-P components - Toolbar -refactored toolbar related files docs * docs: new cem for Topic-P components - Toolbar - removed unnecessary tag rom ToolbarSeparator docs * docs: new cem for Topic-P components - Toolbar -fixed review comments * docs: new cem for Topic-P components - Toolbar - fixed review comments * docs: new cem for Topic-P components - Toolbar - fixed review comments * docs: new cem for Topic-P components - Toolbar - fixed review comments * docs: new cem for Topic-P components - Toolbar - fixed review comments * docs: new cem for Topic-P components - Toolbar - fixed review comments * docs: new cem for Topic-P components - List (#7824) * docs: new cem for Topic-P components - List Issue: #7610 * docs: new cem for Topic-P components - List - fixed review comments * docs: new cem for Topic-P components - List - fixed review comments * docs: new cem for Topic-P components - List - fixed review comments * docs: new cem for Topic-P components - List - fixed review comments * chore: fulfill list * docs(ui5-message-strip): improve documentation (#7917) * docs(ui5-message-strip): improve documentation * docs(ui5-message-strip): reflect review comments * docs(ui5-toast): improve documentation (#7914) * docs(ui5-toast): improve documentation * docs(ui5-toast): reflect review comments * docs: new cem for Topic-P components (#7851) * docs: new cem for Topic-P components (#7850) * docs: new cem for Topic-P components - ui5-select * docs: new cem for Topic-P components - ui5-select * docs: new cem for Topic-P components * docs: new cem for Topic-P components --------- Co-authored-by: Nayden Naydenov <31909318+nnaydenow@users.noreply.github.com> * chore: fulfill * docs: new cem for Topic-P components - Tree (#7927) * fix(ui5-textarea): adjust scroll positioning (#7920) * docs(ui5-select-menu-option): correct disabled property description (#7925) docs(ui5-select-menu-option): correct docs Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com> * docs: new cem for Topic-P components - Tree Issue: #7610 * docs: new cem for Topic-P components - Tree -fixed review comments --------- Co-authored-by: niyap <38278268+niyap@users.noreply.github.com> Co-authored-by: Nayden Naydenov <31909318+nnaydenow@users.noreply.github.com> Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com> * chore: fullfill * docs(ui5-panel): improve documentation (#7924) * docs(ui5-panel): improve documentation * docs(ui5-panel): reflect review comments * docs(ui5-panel): reflect review comments * docs(ui5-page): improve documentation (#7919) * docs: rewrite JSDoc for custom-elements-manifest/analyzer (#7778) * docs: new cem for Topic-RD components JSDoc changes related to using the new custom-elements-manifest for Rodopi-owned components. Issue: #7610 * docs: remove types from enums * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 * chore: fulfill * docs: rewrite JSDoc for custom-elements-manifest/analyzer Related to: #7610 --------- Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com> * chore: ts build * docs: Adapt JSDocs for new CЕM and Remove Redundancies (#7922) * docs: Adapt JSDocs for new CЕM and Remove Redundancies * docs: fix merge conflict * docs: adapt docs to updated specs * docs: fix storybook errors * docs: add missing file * docs: update interfaces * docs: fix comments * docs: fix more comments * docs: another comments fix * docs: fix more comments * docs: fix comments * docs: fix ITtimelineItem interface properties --------- Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com> * docs(ui5-wizard): improve documentation (#7935) * docs(ui5-wizard): improve documentation * docs(ui5-wizard): reflect review comments * docs(ui5-combobox): improve documentation (#7942) * chore: execute package script * chore: extract type of parameters with default and enhace storybook * docs(ui5-multi-combobox): improve documentation (#7944) * chore: fix missed files * chore: fixes * chore: fix superclass references * chore: fix paths * chore: align exports with modules name * chore: fix datepicker * chore: add _ui5validator * docs(ui5-table): improve documentation (#7951) * docs(ui5-table): improve documentation * docs(ui5-table): reflect review comments --------- Co-authored-by: Nia Peeva <niya.peeva@sap.com> * docs(ui5-input, ui5-multi-input): improve documentation (#7969) Co-authored-by: Nia Peeva <niya.peeva@sap.com> * chore: fixes * chore: update schema * chore: handle non metadata props * chore: fix select * fix tree * fix tree items * fix tree * review comments * chore: aling interfaces * cleanup interfaces * chore: tab container * chor: tab container interface * chore: return type of color palette popover * chore: fix tree test * escaped new lines * remove parts * optimizations * chore: fix pathds * chore: make some components private * fix schema validation and cleanup * ehance customElement decorator * customElement decorator * fix globs pattern * makr correctly custom elements * corrections * chore: 2 interfaces added * chore: 2 more fixes * chore: fix label and token * chore: do not sort props --------- Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com> Co-authored-by: Vladislav Tasev <vladislav.tasev@sap.com> Co-authored-by: Plamen Ivanov <plamen.ivanov01@sap.com> Co-authored-by: Ivaylo Plashkov <ivaylo.plashkov@sap.com> Co-authored-by: ilhan orhan <ilhan.orhan007@gmail.com> Co-authored-by: Stoyan <88034608+hinzzx@users.noreply.github.com> Co-authored-by: niyap <38278268+niyap@users.noreply.github.com> Co-authored-by: yanaminkova <32466553+yanaminkova@users.noreply.github.com> Co-authored-by: Siyana Todorova <72251110+s-todorova@users.noreply.github.com> Co-authored-by: Nikolay Hristov <n.hristov@sap.com> Co-authored-by: Nia Peeva <niya.peeva@sap.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
This issue is about wrong documentation
enhancement
New feature or request
TOPIC B
TOPIC Core
TOPIC P
TOPIC RD
TOPIC RL
This issue is follow up of #6958
Background:
Right now, if someone wants to write documentation for their code, they have to use namespaces (like "sap.ui.webc.main"). This is because JSDoc doesn't understand where to assign the comments otherwise. This makes things a bit harder for developers. So, we decided to use a different documentation standard, which is called "custom-elements-manifest." To switch from "api.json" to "custom-elements.json," we need to replace the JSDoc plugin with "custom-elements-manifest/analyzer."
Once we make this change, the way we write our documentation will be different. We'll have to update our JSDoc comments by getting rid of the namespaces, removing tags that we don't use anymore, and so on.
Expectation:
Revise documentation using the details provided below.
Table on contents
JSDOC changes
Class tags
@class
@class
@constructor
@constructor
@public
/@protected
/@private
@public
@protected
@private
@since
@since
1.2.0@deprecated
@depreaceted
@deprecated
version 1.4.0@abstract
@abstract
@implements
@implements
{ShowcaseType}@extends
@extends
ShowcaseType@slot
@csspart
Note: Class name is automatically generated and
@alias
tag is redudantNote: Tag name is automatically generated and
@tagName
is redundantNote: If the component implements more than 1 interface use
@implements
tag for every interface, instead of separating them with comma.Property and getter (readonly property) tags
@public
/@protected
/@private
@public
@protected
@private
@since
@since
1.2.0@deprecated
@depreaceted
@deprecated
version 1.4.0@default
(required for public properties/getters)@default
"myDefaultValue"@formProperty
@formProperty
@formEvents
@formEvents
change inputNote: Type is autmatially calculated from the accesor name.
Note: Property name is automatically generated from accessor name and
@name
tag is redundant.Slot tags
Property slot
Property slot is the slot that has accessor
@public
/@protected
/@private
@public
@protected
@private
@since
@since
1.2.0@deprecated
@depreaceted
@deprecated
version 1.4.0Note: Slot name is automatically generated from accessor name and
@slot
tag is redundant.Note: Type is automatically calculated from the accessor type
Note: If the default is set to true inside the decorator, the slot will appear as default.
Unnamed slot
Property slot is the default slot that doesn't have accessor. This slot is declared inside class comment using
@slot
tag.Event tags
Event tags
@param
@param
{ShowcaseType} testParameter description@public
/@protected
/@private
@public
@protected
@private
@since
@since
1.2.0@deprecated
@depreaceted
@deprecated
version 1.4.0@allowPreventDefault
@allowPreventDefault
@native
@native
Event parameter tags
Now, you can specify
@public
/@protected
/@private
(required if there is a@param tag
with the same name)@public
@protected
@private
@since
@since
1.2.0@deprecated
@depreaceted
@deprecated
version 1.4.0Note: With these tags only deprecated, since and privacy status could be changed. If you want to change the description use
@param
tag in the event description.Note: Now, you have to specify the privacy of the parameter with privacy tag and also to describe the parameter in event comment.
Method tags
@param
@param
param1 parameter description showcase@param
{ShowcaseType} [param2] optional parameter description showcase@public
/@protected
/@private
@public
@protected
@private
@since
@since
1.2.0@deprecated
@depreaceted
@deprecated
version 1.4.0@returns
@returns
return description showcaseNote: Parameters type and return types is generated automatically
Note: Method name is automatically generated from accessor name and
@method
/@name
tag is redundant.Note:
@async
method is redundant because only return type is usedNote:
@static
tag is redundant because it's automatically calculated when the method is staticCSS Part
YOu can defined css part inside class comment using
@csspart
tag.Enum and enum member tags
@public
/@protected
/@private
(required for enum members)@public
@protected
@private
@since
@since
1.2.0@deprecated
@depreaceted
@deprecated
version 1.4.0Note: Enum name is automatically generated from accessor name and
@alias
tag is redundant.Interface tags
@public
/@protected
/@private
@public
@protected
@private
@since
@since
1.2.0@deprecated
@depreaceted
@deprecated
version 1.4.0Note: Interface name is automatically generated from accessor name and @name tag is redundant.
Interface changes
In order to remove sap.ui.webc.main/fiori namespaces we have to replace variable declared interfaces with a TypeScript declared interfaces. At the moment interfaces are only markes but for some of the markers a real interfaces exist so the changes are following:
Interface that can't be transformed to a real interface
Interface that can be transformed to a real interface
NOTE: If the interface is created to describe abstract component (component that doesn't have template) we remove the interface and start to use the class since.
Fixes: #7388 #7075 #6306
The text was updated successfully, but these errors were encountered: