feat(docs): Remove Angular-specific items from public API JSDoc comments#17068
Draft
feat(docs): Remove Angular-specific items from public API JSDoc comments#17068
Conversation
- 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Public API summaries and
@remarkssections contained Angular-specific tags, HTML template snippets withigx-*selectors, and TypeScript usage examples — none of which belong in generic API documentation.Changes
@igxModule,@igxTheme,@igxKeywords,@igxGroup,@igxFriendlyName,@igxParent,@igxElementsAnchor@exampleblocks — both HTML template and TypeScript code snippets@remarksand description bodies<igx-*>elements in description prose)Before / After
Descriptive
@remarksprose 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/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)/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)/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/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)/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)/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/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)/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)/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/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)/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)/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
🔒 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.