Skip to content

feat(docs): Remove Angular-specific items from public API JSDoc comments#17068

Draft
Copilot wants to merge 2 commits intomasterfrom
copilot/improve-public-api-docs
Draft

feat(docs): Remove Angular-specific items from public API JSDoc comments#17068
Copilot wants to merge 2 commits intomasterfrom
copilot/improve-public-api-docs

Conversation

Copy link
Contributor

Copilot AI commented Mar 20, 2026

Public API summaries and @remarks sections contained Angular-specific tags, HTML template snippets with igx-* selectors, and TypeScript usage examples — none of which belong in generic API documentation.

Changes

  • Removed Angular-specific custom tags across 171 files: @igxModule, @igxTheme, @igxKeywords, @igxGroup, @igxFriendlyName, @igxParent, @igxElementsAnchor
  • Stripped all @example blocks — both HTML template and TypeScript code snippets
  • Removed standalone code fences from @remarks and description bodies
  • Removed bare inline HTML (unescaped <igx-*> elements in description prose)
  • Rewrote selector-referencing summaries to plain text (e.g. drop-down item/group, select item group components)

Before / After

/**
 * Badge provides visual notifications used to decorate avatars, menus, etc.
 *
 * @igxModule IgxBadgeModule
 * @igxTheme igx-badge-theme
 * @igxKeywords badge, icon, notification
 * @igxGroup Data Entry & Display
 *
 * @remarks
 * The Ignite UI Badge is used to decorate avatars...
 *
 * @example
 * ```html
 * <igx-avatar>
 *   <igx-badge icon="check" type="success"></igx-badge>
 * </igx-avatar>
 * ```
 */

// ↓ becomes

/**
 * Badge provides visual notifications used to decorate avatars, menus, etc.
 *
 * @remarks
 * The Ignite UI Badge is used to decorate avatars...
 */

Descriptive @remarks prose is preserved; only code examples and framework-specific metadata are removed.

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=5431 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-11423153 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,891332055440852132,11259701249861765306,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,5431407615802398253,12736449194316614354,4 --trace-process-track-uuid=3190708989122997041 grep (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-11423153 --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=11423153 --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=5440 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-58612207 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,6224747356427810581,868590364948942257,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,15648272407387292080,16043136325740424893,4 --trace-process-track-uuid=3190708989122997041 wc (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=5440 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-58612207 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,6224747356427810581,868590364948942257,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,15648272407387292080,16043136325740424893,4 --trace-process-track-uuid=3190708989122997041 wc (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-58612207 --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=58612207 --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=5450 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-65040908 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,11706607672731126212,5300515167269456406,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,14659494312491917422,6065405338859432514,4 --trace-process-track-uuid=3190708989122997041 head (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=5440 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-58612207 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,6224747356427810581,868590364948942257,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,15648272407387292080,16043136325740424893,4 --trace-process-track-uuid=3190708989122997041 wc (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=5431 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-11423153 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,891332055440852132,11259701249861765306,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,5431407615802398253,12736449194316614354,4 --trace-process-track-uuid=3190708989122997041 grep (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=5450 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-65040908 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,11706607672731126212,5300515167269456406,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,14659494312491917422,6065405338859432514,4 --trace-process-track-uuid=3190708989122997041 head (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=5431 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-11423153 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,891332055440852132,11259701249861765306,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,5431407615802398253,12736449194316614354,4 --trace-process-track-uuid=3190708989122997041 grep (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-11423153 --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=11423153 --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=5440 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/karma-58612207 --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,6224747356427810581,868590364948942257,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,15648272407387292080,16043136325740424893,4 --trace-process-track-uuid=3190708989122997041 wc (dns block)

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

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)


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

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

Improve public api docs

2 participants