Skip to content
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

feat: add remaining @docsIncludeIds and validation steps #3076

Merged
merged 20 commits into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ import { NgModule } from '@angular/core';

import { SkyHelpInlineComponent } from './help-inline.component';

/**
* @docsIncludeIds SkyHelpInlineComponent, SkyHelpInlineHarness, SkyHelpInlineHarnessFilters
*/
@NgModule({
imports: [SkyHelpInlineComponent],
exports: [SkyHelpInlineComponent],
Expand Down
3 changes: 3 additions & 0 deletions libs/components/i18n/src/lib/modules/i18n/i18n.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ import { NgModule } from '@angular/core';
import { SkyLibResourcesPipe } from './lib-resources.pipe';
import { SkyAppResourcesPipe } from './resources.pipe';

/**
* @docsIncludeIds SkyAppResourcesPipe, SkyAppResourcesService, SkyAppResources, SkyLibResourcesPipe, SkyLibResourcesService, SkyLibResources, SkyLibResourcesProvider, SKY_LIB_RESOURCES_PROVIDERS, SkyAppLocaleInfo, SkyAppLocaleProvider, SkyAppResourceNameProvider, SkyI18nCurrencyFormatService, SkyIntlDateFormatter, SkyIntlNumberFormatter, SkyI18nCurrencyFormat, SkyI18nCurrencySymbolLocation, SkyIntlNumberFormatStyle
*/
@NgModule({
declarations: [SkyAppResourcesPipe, SkyLibResourcesPipe],
exports: [SkyAppResourcesPipe, SkyLibResourcesPipe],
Expand Down
3 changes: 3 additions & 0 deletions libs/components/icon/src/lib/modules/icon/icon.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ import { SkyIconStackComponent } from './icon-stack.component';
import { SkyIconSvgComponent } from './icon-svg.component';
import { SkyIconComponent } from './icon.component';

/**
* @docsIncludeIds SkyIconComponent, SkyIconType, SkyIconVariantType, SkyIconHarness, SkyIconHarnessFilters
*/
@NgModule({
declarations: [SkyIconClassListPipe, SkyIconComponent, SkyIconStackComponent],
imports: [CommonModule, SkyIconSvgComponent],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ import { SkyIndicatorsResourcesModule } from '../shared/sky-indicators-resources

import { SkyAlertComponent } from './alert.component';

/**
* @docsIncludeIds SkyAlertComponent, SkyAlertHarness, SkyAlertHarnessFilters
*/
@NgModule({
declarations: [SkyAlertComponent],
imports: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ import { NgModule } from '@angular/core';

import { SkyIllustrationComponent } from './illustration.component';

/**
* @docsIncludeIds SkyIllustrationComponent, SkyIllustrationResolverService, SkyIllustrationSize, SkyIllustrationHarness, SkyIllustrationHarnessFilters
*/
@NgModule({
imports: [SkyIllustrationComponent],
exports: [SkyIllustrationComponent],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ import { SkyKeyInfoLabelComponent } from './key-info-label.component';
import { SkyKeyInfoValueComponent } from './key-info-value.component';
import { SkyKeyInfoComponent } from './key-info.component';

/**
* @docsIncludeIds SkyKeyInfoComponent, SkyKeyInfoLabelComponent, SkyKeyInfoValueComponent, SkyKeyInfoLayoutType, SkyKeyInfoHarness, SkyKeyInfoHarnessFilters
*/
@NgModule({
declarations: [
SkyKeyInfoComponent,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ import { SkyIndicatorsResourcesModule } from '../shared/sky-indicators-resources

import { SkyLabelComponent } from './label.component';

/**
* @docsIncludeIds SkyLabelComponent, SkyLabelType, SkyLabelHarness, SkyLabelHarnessFilters
*/
@NgModule({
declarations: [SkyLabelComponent],
imports: [CommonModule, SkyIconModule, SkyIndicatorsResourcesModule],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ import { SkyIndicatorsResourcesModule } from '../shared/sky-indicators-resources

import { SkyStatusIndicatorComponent } from './status-indicator.component';

/**
* @docsIncludeIds SkyStatusIndicatorComponent, SkyStatusIndicatorHarness, SkyStatusIndicatorHarnessFilters
*/
@NgModule({
declarations: [SkyStatusIndicatorComponent],
imports: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ import { SkyMutationObserverService } from '@skyux/core';

import { SkyTextHighlightDirective } from './text-highlight.directive';

/**
* @docsIncludeIds SkyTextHighlightDirective
*/
@NgModule({
imports: [SkyTextHighlightDirective],
exports: [SkyTextHighlightDirective],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ import { SkyIndicatorsResourcesModule } from '../shared/sky-indicators-resources
import { SkyTokenComponent } from './token.component';
import { SkyTokensComponent } from './tokens.component';

/**
* @docsIncludeIds SkyTokensComponent, SkyTokenComponent, SkyToken, SkyTokenSelectedEventArgs, SkyTokensMessage, SkyTokensMessageType, SkyTokensHarness, SkyTokenHarness
*/
@NgModule({
declarations: [SkyTokenComponent, SkyTokensComponent],
imports: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ import { NgModule } from '@angular/core';

import { SkyWaitComponent } from './wait.component';

/**
* @docsIncludeIds SkyWaitComponent, SkyWaitService, SkyWaitHarness, SkyWaitHarnessFilters
*/
@NgModule({
imports: [SkyWaitComponent],
exports: [SkyWaitComponent],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { SkyComponentHarness } from '@skyux/core/testing';

/**
* Harness for interacting with a chevron component in tests.
* @internal
Blackbaud-SteveBrush marked this conversation as resolved.
Show resolved Hide resolved
*/
export class SkyChevronHarness extends SkyComponentHarness {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ import { SkyInlineFormResourcesModule } from '../shared/sky-inline-form-resource

import { SkyInlineFormComponent } from './inline-form.component';

/**
* @docsIncludeIds SkyInlineFormComponent, SkyInlineFormConfig, SkyInlineFormButtonConfig, SkyInlineFormButtonLayout, SkyInlineFormCloseArgs
*/
@NgModule({
declarations: [SkyInlineFormComponent],
imports: [CommonModule, SkyInlineFormResourcesModule],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ import { SkyActionButtonHeaderComponent } from './action-button-header.component
import { SkyActionButtonIconComponent } from './action-button-icon.component';
import { SkyActionButtonComponent } from './action-button.component';

/**
* @docsIncludeIds SkyActionButtonContainerComponent, SkyActionButtonComponent, SkyActionButtonIconComponent, SkyActionButtonHeaderComponent, SkyActionButtonDetailsComponent, SkyActionButtonPermalink, SkyActionButtonContainerAlignItemsType
*/
@NgModule({
declarations: [
SkyActionButtonComponent,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ import { SkyLayoutResourcesModule } from '../shared/sky-layout-resources.module'
import { SkyBackToTopComponent } from './back-to-top.component';
import { SkyBackToTopDirective } from './back-to-top.directive';

/**
* @docsIncludeIds SkyBackToTopDirective, SkyBackToTopOptions, SkyBackToTopMessage, SkyBackToTopMessageType
*/
@NgModule({
declarations: [SkyBackToTopComponent, SkyBackToTopDirective],
imports: [SkyLayoutResourcesModule, SkyThemeModule],
Expand Down
3 changes: 3 additions & 0 deletions libs/components/layout/src/lib/modules/box/box.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ import { SkyBoxControlsComponent } from './box-controls.component';
import { SkyBoxHeaderComponent } from './box-header.component';
import { SkyBoxComponent } from './box.component';

/**
* @docsIncludeIds SkyBoxComponent, SkyBoxHeaderComponent, SkyBoxContentComponent, SkyBoxControlsComponent, SkyBoxHeadingLevel, SkyBoxHeadingStyle, SkyBoxHarness, SkyBoxHarnessFilters
*/
@NgModule({
declarations: [
SkyBoxComponent,
Expand Down
1 change: 1 addition & 0 deletions libs/components/layout/src/lib/modules/card/card.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import { SkyCardComponent } from './card.component';

/**
* @deprecated `SkyCardModule` is deprecated. For other SKY UX components that group and list content, see the content containers guidelines. For more information, see https://developer.blackbaud.com/skyux/design/guidelines/content-containers.
* @docsIncludeIds SkyCardComponent, SkyCardTitleComponent, SkyCardContentComponent, SkyCardActionsComponent
*/
@NgModule({
declarations: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ import { SkyDefinitionListComponent } from './definition-list.component';
/**
* @deprecated Use `SkyDescriptionListModule` instead.
*/

/**
* @docsIncludeIds SkyDefinitionListComponent, SkyDefinitionListHeadingComponent, SkyDefinitionListContentComponent, SkyDefinitionListLabelComponent, SkyDefinitionListValueComponent
*/
@NgModule({
declarations: [
SkyDefinitionListComponent,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ import { SkyDescriptionListDescriptionComponent } from './description-list-descr
import { SkyDescriptionListTermComponent } from './description-list-term.component';
import { SkyDescriptionListComponent } from './description-list.component';

/**
* @docsIncludeIds SkyDescriptionListComponent, SkyDescriptionListContentComponent, SkyDescriptionListDescriptionComponent, SkyDescriptionListTermComponent, SkyDescriptionListModeType
*/
@NgModule({
declarations: [
SkyDescriptionListComponent,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ import { SkyColumnComponent } from './column.component';
import { SkyFluidGridComponent } from './fluid-grid.component';
import { SkyRowComponent } from './row.component';

/**
* @docsIncludeIds SkyFluidGridComponent, SkyRowComponent, SkyColumnComponent, SkyFluidGridGutterSizeType, SkyColumnHarness, SkyColumnHarnessFilters, SkyFluidGridHarness, SkyFluidGridHarnessFilters, SkyRowHarness, SkyRowHarnessFilters
*/
@NgModule({
imports: [CommonModule],
declarations: [SkyRowComponent, SkyColumnComponent, SkyFluidGridComponent],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ import { NgModule } from '@angular/core';

import { SkyFormatComponent } from './format.component';

/**
* @docsIncludeIds SkyFormatComponent, SkyAppFormat
*/
@NgModule({
declarations: [SkyFormatComponent],
imports: [CommonModule],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ import { SkyLayoutResourcesModule } from '../shared/sky-layout-resources.module'

import { SkyInlineDeleteComponent } from './inline-delete.component';

/**
* @docsIncludeIds SkyInlineDeleteComponent
*/
@NgModule({
declarations: [SkyInlineDeleteComponent],
imports: [SkyLayoutResourcesModule, SkyWaitModule],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { SkyPageSummaryComponent } from './page-summary.component';

/**
* @deprecated `SkyPageSummaryModule` is deprecated. For page templates and techniques to summarize page content, see the page design guidelines. For more information, see https://developer.blackbaud.com/skyux/design/guidelines/page-layouts.
* @docsIncludeIds SkyPageSummaryComponent, SkyPageSummaryTitleComponent, SkyPageSummarySubtitleComponent, SkyPageSummaryAlertComponent, SkyPageSummaryContentComponent, SkyPageSummaryImageComponent, SkyPageSummaryKeyInfoComponent, SkyPageSummaryStatusComponent
*/
@NgModule({
declarations: [
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
/**
* @docsId SkyPageLayoutLegacy
* @deprecated Use `SkyPageLayoutType` in `@skyux/pages` instead.
*/
export type SkyPageLayoutType = 'auto' | 'fit';
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { SkyPageThemeAdapterService } from './page-theme-adapter.service';

/**
* Displays page contents using the specified layout.
* @docsId SkyPageComponentLegacy
* @deprecated Use the `sky-page` component in `@skyux/pages` instead.
*/
@Component({
Expand Down
2 changes: 2 additions & 0 deletions libs/components/layout/src/lib/modules/page/page.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import { NgModule } from '@angular/core';
import { SkyPageComponent } from './page.component';

/**
* @docsId SkyPageModuleLegacy
* @docsIncludeIds SkyPageComponentLegacy, SkyPageLayoutLegacy
* @deprecated Use the SkyPageModule in `@skyux/pages` instead.
*/
@NgModule({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ import { SkyLayoutResourcesModule } from '../shared/sky-layout-resources.module'

import { SkyTextExpandRepeaterComponent } from './text-expand-repeater.component';

/**
* @docsIncludeIds SkyTextExpandRepeaterComponent, SkyTextExpandRepeaterListStyleType
*/
@NgModule({
declarations: [SkyTextExpandRepeaterComponent],
imports: [SkyLayoutResourcesModule, CommonModule],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ import { NgModule } from '@angular/core';

import { SkyTextExpandComponent } from './text-expand.component';

/**
* @docsIncludeIds SkyTextExpandComponent, SkyTextExpandHarness, SkyTextExpandModalHarness
*/
@NgModule({
declarations: [SkyTextExpandComponent],
exports: [SkyTextExpandComponent],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ import { SkyToolbarSectionComponent } from './toolbar-section.component';
import { SkyToolbarViewActionsComponent } from './toolbar-view-actions.component';
import { SkyToolbarComponent } from './toolbar.component';

/**
* @docsIncludeIds SkyToolbarComponent, SkyToolbarSectionComponent, SkyToolbarItemComponent, SkyToolbarViewActionsComponent, SkyToolbarHarness, SkyToolbarHarnessFilters, SkyToolbarSectionHarness, SkyToolbarSectionHarnessFilters, SkyToolbarItemHarness, SkyToolbarItemHarnessFilters, SkyToolbarViewActionsHarness
*/
@NgModule({
declarations: [
SkyToolbarComponent,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ import { SkyListsResourcesModule } from '../shared/sky-lists-resources.module';

import { SkyInfiniteScrollComponent } from './infinite-scroll.component';

/**
* @docsIncludeIds SkyInfiniteScrollComponent
*/
@NgModule({
declarations: [SkyInfiniteScrollComponent],
imports: [SkyListsResourcesModule, SkyWaitModule],
Expand Down
3 changes: 3 additions & 0 deletions libs/components/lists/src/lib/modules/paging/paging.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ import { SkyListsResourcesModule } from '../shared/sky-lists-resources.module';
import { SkyPagingContentComponent } from './paging-content.component';
import { SkyPagingComponent } from './paging.component';

/**
* @docsIncludeIds SkyPagingComponent, SkyPagingContentComponent, SkyPagingContentChangeArgs
*/
@NgModule({
declarations: [SkyPagingComponent],
imports: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ import { SkyAutocompleteInputDirective } from './autocomplete-input.directive';
import { SkyAutocompleteSearchAsyncDisabledPipe } from './autocomplete-search-async-disabled.pipe';
import { SkyAutocompleteComponent } from './autocomplete.component';

/**
* @docsIncludeIds SkyAutocompleteComponent, SkyAutocompleteInputDirective, SkyAutocompleteSearchArgs, SkyAutocompleteSearchAsyncArgs, AutocompleteSearchAsyncResultDisplayType, SkyAutocompleteSearchAsyncResult, SkyAutocompleteSearchContext, SkyAutocompleteSearchFunctionFilter, SkyAutocompleteSearchFunctionResponse, SkyAutocompleteSearchFunction, SkyAutocompleteSelectionChange, SkyAutocompleteHarness, SkyAutocompleteHarnessFilters, SkyAutocompleteSearchResultHarness
*/
@NgModule({
declarations: [
SkyAutocompleteComponent,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ import { SkyLookupResourcesModule } from '../shared/sky-lookup-resources.module'

import { SkyCountryFieldComponent } from './country-field.component';

/**
* @docsIncludeIds SkyCountryFieldComponent, SkyCountryFieldCountry, SkyCountryFieldHarness, SkyCountryFieldHarnessFilters, SkyCountryFieldSearchResultHarness
*/
@NgModule({
declarations: [SkyCountryFieldComponent],
imports: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ import { SkyLookupResourcesModule } from '../shared/sky-lookup-resources.module'

import { SkyLookupComponent } from './lookup.component';

/**
* @docsIncludeIds SkyLookupComponent, SkyLookupAddCallbackArgs, SkyLookupAddClickEventArgs, SkyLookupSelectModeType, SkyLookupShowMoreConfig, SkyLookupShowMoreCustomPickerContext, SkyLookupShowMoreCustomPicker, SkyLookupShowMoreNativePickerConfig, SkyLookupHarness
*/
@NgModule({
declarations: [SkyLookupComponent],
imports: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ import { SkyLookupResourcesModule } from '../shared/sky-lookup-resources.module'

import { SkySearchComponent } from './search.component';

/**
* @docsIncludeIds SkySearchComponent, SkySearchHarness
*/
@NgModule({
declarations: [SkySearchComponent],
imports: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,9 @@ import { NgModule } from '@angular/core';
/**
* @deprecated The `SkySelectionModalModule` is no longer needed and can be removed from your application.
*/

/**
* @docsIncludeIds SkySelectionModalService, SkySelectionModalAddCallbackArgs, SkySelectionModalAddClickEventArgs, SkySelectionModalCloseArgs, SkySelectionModalOpenArgs, SkySelectionModalResult, SkySelectionModalSearchArgs, SkySelectionModalSearchResult, SkySelectionModalHarness, SkySelectionModalSearchResultHarnessFilters, SkySelectionModalSearchResultHarness
*/
@NgModule({})
export class SkySelectionModalModule {}
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { SkyConfirmComponent } from './confirm.component';

/**
* Launches a dialog.
* @docsIncludeIds SkyConfirmService, SkyConfirmConfig, SkyConfirmInstance, SkyConfirmType, SkyConfirmButtonConfig, SkyConfirmButtonStyleType, SkyConfirmCloseEventArgs, SkyConfirmHarness, SkyConfirmButtonHarnessFilters, SkyConfirmTestingController, SkyConfirmTestingModule
*/
@Injectable({
providedIn: 'root',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ import { SkyPageHeaderAvatarComponent } from './page-header-avatar.component';
import { SkyPageHeaderDetailsComponent } from './page-header-details.component';
import { SkyPageHeaderComponent } from './page-header.component';

/**
* @docsIncludeIds SkyPageHeaderComponent, SkyPageHeaderDetailsComponent, SkyPageHeaderActionsComponent, SkyPageHeaderAlertsComponent, SkyPageHeaderAvatarComponent, SkyPageHeaderHarness, SkyPageHeaderHarnessFilters
*/
@NgModule({
imports: [
RouterModule,
Expand Down
3 changes: 3 additions & 0 deletions libs/components/pages/src/lib/modules/page/page.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ import { SkyPageContentComponent } from './page-content.component';
import { SkyPageLinksComponent } from './page-links.component';
import { SkyPageComponent } from './page.component';

/**
* @docsIncludeIds SkyPageComponent, SkyPageHeaderModule, SkyPageContentComponent, SkyPageLinksComponent, SkyPageLayoutType, SkyPageHarness, SkyPageHarnessFilters
*/
@NgModule({
declarations: [SkyPageComponent, SkyPageContentComponent],
imports: [
Expand Down
Loading