feat(docs): Improve public API JSDoc descriptions to use generic names by Copilot · Pull Request #17068 · IgniteUI/igniteui-angular

Copilot · 2026-03-20T12:25:26Z

Public API summaries and @remarks sections contained Angular-specific class name references (e.g. IgxGridRowComponent, IgxChipComponent) that don't belong in generic API documentation.

Changes

Preserved as-is: @igxModule, @igxTheme, @igxKeywords, @igxGroup, @igxFriendlyName, @igxParent, @igxElementsAnchor tags and all @example blocks (including HTML template and TypeScript code snippets)
Replaced Angular class name references in description text and @remarks prose with generic readable names across 104 files — e.g. IgxGridRowComponent → grid row, IgxChipComponent → chip, IgxCarouselComponent → carousel
Skipped replacements inside @example blocks, code fences, @igx* tag lines, and URLs to avoid breaking documentation links

Before / After

/**
 * Returns the data for the new `IgxGridRowComponent` object.
 */

// ↓ becomes

/**
 * Returns the data for the new grid row object.
 */

/**
 * Defines if the `IgxChipComponent` can be dragged in order to change its position.
 *
 * @example
 * ```html
 * <igx-chip [draggable]="true">...</igx-chip>
 * ```
 */

// ↓ becomes (description updated, @example block preserved)

/**
 * Defines if the chip can be dragged in order to change its position.
 *
 * @example
 * ```html
 * <igx-chip [draggable]="true">...</igx-chip>
 * ```
 */

Descriptive prose is updated to use generic names; all @igx* metadata tags and @example code blocks remain untouched.

Original prompt

This section details on the original issue you should resolve

<issue_title>Improve public api docs</issue_title>
<issue_description>## Is your feature request related to a problem? Please describe.
Make sure the public api summary and @remarks notes do not contain angular specific items. we should use generic descriptions and not mention selectors or tags or contain code snippets. Transform those into plain text.

For example:
///

/// Returns IgxGridRow object by the specified primary key.
/// @remarks
/// Requires that the primaryKey property is set.

should be
///

/// Returns row object by the specified primary key.
/// @remarks
/// Requires that the primary key is set.
</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes Improve public api docs #17067

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

@example

- Remove @igxModule, @igxTheme, @igxKeywords, @igxGroup, @igxFriendlyName, @igxParent, @igxElementsAnchor tags from JSDoc comments across 171 files - Remove all @example code blocks (HTML templates and TypeScript snippets) - Remove standalone code blocks from descriptions and @remarks sections - Remove bare HTML elements (igx- tags) from JSDoc descriptions - Replace inline selector references with plain text names in component descriptions - Build and tests verified to pass Co-authored-by: dkamburov <1182001+dkamburov@users.noreply.github.com>

dkamburov · 2026-04-09T09:04:04Z

@copilot
Do not modify or remove the following sections: @igxModule, @igxKeywords, @igxGroup and @example you have to leave those as is, so revert the changes and not remove or modify those. Work on the descriptions and remarks of the API. For example:
Returns the data for the new IgxGridRowComponent object.
Should be Returns the data for the new grid row object.

This reverts commit 35bf50e. Co-authored-by: dkamburov <1182001+dkamburov@users.noreply.github.com>

@example

- Revert previous removal of @igxModule, @igxKeywords, @igxGroup, @example - Keep @igxModule, @igxKeywords, @igxGroup, @igxTheme, and @example blocks intact - Replace Angular-specific class names (IgxXxxComponent, IgxXxxDirective, etc.) in JSDoc descriptions and remarks with generic readable names e.g. IgxGridRowComponent -> grid row, IgxChipComponent -> chip - Skip replacements inside @example blocks, code blocks, @iGx tag lines, and URLs - 104 files updated with generic descriptions Agent-Logs-Url: https://github.com/IgniteUI/igniteui-angular/sessions/b15d3343-b97e-4970-bd8b-ea0483a7460b Co-authored-by: dkamburov <1182001+dkamburov@users.noreply.github.com>

Copilot · 2026-04-09T09:56:32Z

@copilot
Do not modify or remove the following sections: @igxModule, @igxKeywords, @igxGroup and @example you have to leave those as is, so revert the changes and not remove or modify those. Work o...

Done in commit 2cba50f. The previous changes have been reverted and replaced with a new approach:

Preserved as-is: @igxModule, @igxKeywords, @igxGroup, @igxTheme, and all @example blocks (including their HTML/TypeScript code content)
Updated: Angular class name references in JSDoc descriptions and @remarks text are replaced with generic names, e.g.:
- Returns the data for the new \IgxGridRowComponent` object.→Returns the data for the new grid row object.`
- Defines if the \IgxChipComponent` can be dragged...→Defines if the chip can be dragged...`
- IgxAccordion is a container-based component... → Accordion is a container-based component...

Replacements are skipped inside @example blocks, code fences, and URLs (so documentation links like classes/IgxColumnComponent.html remain intact).

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

accounts.google.com
- Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --crashpad-handler-pid=5342 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-60879650 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,12491236728784202974,11650706107019743762,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,4489925211096384916,14120230537325684532,4 --trace-process-track-uuid=3190708989122997041 bash (dns block)
- Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --crashpad-handler-pid=5338 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-59260209 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,3890820555047130600,10207930221692526432,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,6928001605666401502,4505716290315332208,4 --trace-process-track-uuid=3190708989122997041 bash (dns block)
- Triggering command: /home/REDACTED/.cache/puppeteer/chrome/linux-146.0.7680.153/chrome-linux64/chrome /home/REDACTED/.cache/puppeteer/chrome/linux-146.0.7680.153/chrome-linux64/chrome --user-data-dir=/tmp/karma-60879650 --enable-automation --no-default-browser-check --no-first-run --disable-default-apps --disable-popup-blocking --disable-translate --disable-REDACTED-timer-throttling --disable-renderer-REDACTEDing --disable-device-discovery-notifications --no-sandbox --disable-gpu --window-size=820,800 --js-flags=--expose-gc http://localhost:9876/?id=60879650 --headless --disable-gpu --disable-dev-shm-usage --remote-debugging-port=9222 (dns block)
clients2.google.com
- Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --crashpad-handler-pid=5338 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-59260209 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,3890820555047130600,10207930221692526432,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,6928001605666401502,4505716290315332208,4 --trace-process-track-uuid=3190708989122997041 bash (dns block)
- Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --crashpad-handler-pid=5342 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-60879650 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,12491236728784202974,11650706107019743762,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,4489925211096384916,14120230537325684532,4 --trace-process-track-uuid=3190708989122997041 bash (dns block)
- Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --crashpad-handler-pid=5345 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-54885928 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,11432316462999046665,11535461114036694793,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,1307179806492100434,9334816428649239252,4 --trace-process-track-uuid=3190708989122997041 bash (dns block)
redirector.gvt1.com
- Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --crashpad-handler-pid=5338 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-59260209 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,3890820555047130600,10207930221692526432,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,6928001605666401502,4505716290315332208,4 --trace-process-track-uuid=3190708989122997041 bash (dns block)
- Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --crashpad-handler-pid=5342 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-60879650 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,12491236728784202974,11650706107019743762,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,4489925211096384916,14120230537325684532,4 --trace-process-track-uuid=3190708989122997041 bash (dns block)
- Triggering command: /home/REDACTED/.cache/puppeteer/chrome/linux-146.0.7680.153/chrome-linux64/chrome /home/REDACTED/.cache/puppeteer/chrome/linux-146.0.7680.153/chrome-linux64/chrome --user-data-dir=/tmp/karma-60879650 --enable-automation --no-default-browser-check --no-first-run --disable-default-apps --disable-popup-blocking --disable-translate --disable-REDACTED-timer-throttling --disable-renderer-REDACTEDing --disable-device-discovery-notifications --no-sandbox --disable-gpu --window-size=820,800 --js-flags=--expose-gc http://localhost:9876/?id=60879650 --headless --disable-gpu --disable-dev-shm-usage --remote-debugging-port=9222 (dns block)
www.google.com
- Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --crashpad-handler-pid=5338 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-59260209 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,3890820555047130600,10207930221692526432,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,6928001605666401502,4505716290315332208,4 --trace-process-track-uuid=3190708989122997041 bash (dns block)
- Triggering command: /home/REDACTED/.cache/puppeteer/chrome/linux-146.0.7680.153/chrome-linux64/chrome /home/REDACTED/.cache/puppeteer/chrome/linux-146.0.7680.153/chrome-linux64/chrome --user-data-dir=/tmp/karma-59260209 --enable-automation --no-default-browser-check --no-first-run --disable-default-apps --disable-popup-blocking --disable-translate --disable-REDACTED-timer-throttling --disable-renderer-REDACTEDing --disable-device-discovery-notifications --no-sandbox --disable-gpu --window-size=820,800 --js-flags=--expose-gc http://localhost:9876/?id=59260209 --headless --disable-gpu --disable-dev-shm-usage --remote-debugging-port=9222 (dns block)
- Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --crashpad-handler-pid=5342 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-60879650 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,12491236728784202974,11650706107019743762,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,4489925211096384916,14120230537325684532,4 --trace-process-track-uuid=3190708989122997041 bash (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

dkamburov · 2026-04-09T10:56:22Z

@copilot don't change memberof as well.

@memberof

… intact Also do not modify @memberof/@memberof tag lines per reviewer feedback. 78 files updated with generic class name descriptions. Agent-Logs-Url: https://github.com/IgniteUI/igniteui-angular/sessions/6cda1570-4ce7-4e42-a7a8-eac9eff61035 Co-authored-by: dkamburov <1182001+dkamburov@users.noreply.github.com>

Copilot · 2026-04-09T11:02:06Z

@copilot don't change memberof as well.

Fixed in commit 281056e. @memberof/@memberOf tag lines are now preserved unchanged alongside @igxModule, @igxKeywords, @igxGroup, and @example blocks.

dkamburov · 2026-06-01T13:44:47Z

@copilot don't change the links - {@link *}. They should stay with the specified selectors

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

kdinev · 2026-06-17T08:22:47Z

-     * Gets the type of the `IgxSliderComponent`.
-     * The slider can be IgxSliderType.SLIDER(default) or IgxSliderType.RANGE.
+     * Gets the type of the slider.
+     * The slider type can be SLIDER(default) or RANGE.


Suggested change

* The slider type can be SLIDER(default) or RANGE.

* The slider type can be SLIDER (default) or RANGE.

kdinev · 2026-06-17T08:22:57Z

-     * Sets the type of the `IgxSliderComponent`.
-     * The slider can be IgxSliderType.SLIDER(default) or IgxSliderType.RANGE.
+     * Sets the type of the slider.
+     * The slider type can be SLIDER(default) or RANGE.


Suggested change

* The slider type can be SLIDER(default) or RANGE.

* The slider type can be SLIDER (default) or RANGE.

Initial plan

d6f61c7

Copilot AI assigned Copilot and dkamburov Mar 20, 2026

Copilot started work on behalf of dkamburov March 20, 2026 12:25 View session

Copilot AI changed the title ~~[WIP] Update public API documentation to remove Angular specifics~~ feat(docs): Remove Angular-specific items from public API JSDoc comments Mar 20, 2026

Copilot AI requested a review from dkamburov March 20, 2026 12:48

Copilot finished work on behalf of dkamburov March 20, 2026 12:48

Copilot started work on behalf of dkamburov April 9, 2026 09:04 View session

Copilot AI and others added 2 commits April 9, 2026 09:07

Revert "feat(docs): remove Angular-specific items from public API docs"

2e82839

This reverts commit 35bf50e. Co-authored-by: dkamburov <1182001+dkamburov@users.noreply.github.com>

Copilot AI changed the title ~~feat(docs): Remove Angular-specific items from public API JSDoc comments~~ feat(docs): Improve public API JSDoc descriptions to use generic names Apr 9, 2026

Copilot finished work on behalf of dkamburov April 9, 2026 10:08

Copilot started work on behalf of dkamburov April 9, 2026 10:56 View session

Copilot finished work on behalf of dkamburov April 9, 2026 11:04

dkamburov and others added 6 commits April 9, 2026 14:52

Merge branch 'master' into copilot/improve-public-api-docs

e01a0bb

Merge branch 'master' into copilot/improve-public-api-docs

8be3505

chore(*): fix conflict resolution issues

c2ca353

chore(*): undo package.lock changes

c655702

docs(*): improve clarity across several components

82020f9

Merge branch 'master' into copilot/improve-public-api-docs

7cad390

Copilot started work on behalf of dkamburov June 1, 2026 13:45 View session

fix(docs): preserve {@link} class references unchanged in JSDoc comments

b725cd1

Copilot finished work on behalf of dkamburov June 1, 2026 13:49

docs(slider): improve clarity in slider type descriptions

ad815a3

dkamburov approved these changes Jun 1, 2026

View reviewed changes

dkamburov marked this pull request as ready for review June 1, 2026 13:58

Copilot AI review requested due to automatic review settings June 1, 2026 13:58

dkamburov assigned Hristo313 Jun 1, 2026

Copilot started reviewing on behalf of dkamburov June 1, 2026 13:58 View session

dkamburov requested a review from ChronosSF June 1, 2026 13:59

Copilot AI reviewed Jun 1, 2026

Hristo313 added the ✅ status: verified Applies to PRs that have passed manual verification label Jun 2, 2026

Merge branch 'master' into copilot/improve-public-api-docs

a45c262

kdinev requested changes Jun 17, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(docs): Improve public API JSDoc descriptions to use generic names#17068

feat(docs): Improve public API JSDoc descriptions to use generic names#17068
Copilot wants to merge 14 commits into
masterfrom
copilot/improve-public-api-docs

Copilot AI commented Mar 20, 2026 •

edited

Loading

Comments on the Issue (you are @copilot in this section)

Uh oh!

dkamburov commented Apr 9, 2026

Uh oh!

Copilot AI commented Apr 9, 2026 •

edited

Loading

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

dkamburov commented Apr 9, 2026

Uh oh!

Copilot AI commented Apr 9, 2026

Uh oh!

dkamburov commented Jun 1, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

kdinev Jun 17, 2026

Uh oh!

kdinev Jun 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

	* The slider type can be SLIDER(default) or RANGE.
	* The slider type can be SLIDER (default) or RANGE.

Conversation

Copilot AI commented Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Before / After

Comments on the Issue (you are @copilot in this section)

Uh oh!

dkamburov commented Apr 9, 2026

Uh oh!

Copilot AI commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

dkamburov commented Apr 9, 2026

Uh oh!

Copilot AI commented Apr 9, 2026

Uh oh!

dkamburov commented Jun 1, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

kdinev Jun 17, 2026

Choose a reason for hiding this comment

Uh oh!

kdinev Jun 17, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Copilot AI commented Mar 20, 2026 •

edited

Loading

Copilot AI commented Apr 9, 2026 •

edited

Loading