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

[Copilot]

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.

[dkamburov]

@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.

[Copilot]

@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]

@copilot don't change memberof as well.

[Copilot]

@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.