Skip to content
This repository was archived by the owner on Jan 19, 2023. It is now read-only.

Commit 4a9f7da

Browse files
petebacondarwinthePunderWoman
authored andcommitted
docs: remove unused "docregions" (angular#40479)
This commit removes all the docregion tags in examples that are not being referenced in any doc. PR Close angular#40479
1 parent fb97e67 commit 4a9f7da

File tree

184 files changed

+65
-1037
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

184 files changed

+65
-1037
lines changed

aio/content/examples/ajs-quick-reference/src/app/movie-list.component.html

-2
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,7 @@ <h3 [hidden]="!favoriteHero">
6767
<td>{{movie.hero}}</td>
6868
<td>{{movie.releaseDate | date}}</td>
6969
<td>{{movie.mpaa | uppercase}}</td>
70-
<!-- #docregion currency -->
7170
<td>{{movie.price | currency:'USD':true}}</td>
72-
<!-- #enddocregion currency -->
7371
<td>{{movie.starRating | number:'1.1-2'}}</td>
7472
<td>{{movie.approvalRating | percent: '1.0-0'}}</td>
7573
</tr>

aio/content/examples/ajs-quick-reference/src/app/movie-list.component.ts

-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
/* tslint:disable:no-unused-variable */
22
// #docplaster
3-
// #docregion import
43
import { Component } from '@angular/core';
5-
// #enddocregion import
64
import { IMovie } from './movie';
75
import { MovieService } from './movie.service';
86

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,6 @@
11
// #docplaster
2-
// #docregion imports
32
import { Component, HostBinding } from '@angular/core';
4-
import {
5-
trigger,
6-
state,
7-
style,
8-
animate,
9-
transition,
10-
// ...
11-
} from '@angular/animations';
123

13-
// #enddocregion imports
14-
15-
// #docregion decorator, toggle-app-animations
164
@Component({
175
selector: 'app-root',
186
templateUrl: 'app.component.html',
@@ -21,15 +9,10 @@ import {
219
// animation triggers go here
2210
]
2311
})
24-
// #enddocregion decorator
2512
export class AppComponent {
26-
@HostBinding('@.disabled')
27-
public animationsDisabled = false;
28-
// #enddocregion toggle-app-animations
13+
@HostBinding('@.disabled') public animationsDisabled = false;
2914

3015
toggleAnimations() {
3116
this.animationsDisabled = !this.animationsDisabled;
3217
}
33-
// #docregion toggle-app-animations
3418
}
35-
// #enddocregion toggle-app-animations

aio/content/examples/animations/src/app/hero-list-enter-leave.component.ts

-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ import { Hero } from './hero';
1616

1717
@Component({
1818
selector: 'app-hero-list-enter-leave',
19-
// #docregion template
2019
template: `
2120
<ul class="heroes">
2221
<li *ngFor="let hero of heroes"
@@ -28,7 +27,6 @@ import { Hero } from './hero';
2827
</li>
2928
</ul>
3029
`,
31-
// #enddocregion template
3230
styleUrls: ['./hero-list-page.component.css'],
3331
// #docregion animationdef
3432
animations: [
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
1-
<!-- #docplaster -->
21
<nav>
32
<button (click)="toggle()">Toggle Open/Close</button>
43
</nav>
54

6-
<!-- #docregion compare, trigger -->
75
<div [@openClose]="isOpen ? 'open' : 'closed'"
86
(@openClose.start)="onAnimationEvent($event)"
97
(@openClose.done)="onAnimationEvent($event)"
108
class="open-close-container">
119
<p>The box is now {{ isOpen ? 'Open' : 'Closed' }}!</p>
1210
</div>
13-
<!-- #enddocregion compare, trigger -->

aio/content/examples/animations/src/app/open-close.component.ts

+5-6
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { trigger, transition, state, animate, style, AnimationEvent } from '@ang
55
// #docregion component, events1
66
@Component({
77
selector: 'app-open-close',
8-
// #docregion trigger, trigger-wildcard1, trigger-transition
8+
// #docregion trigger-wildcard1, trigger-transition
99
animations: [
1010
trigger('openClose', [
1111
// #docregion state1
@@ -33,7 +33,7 @@ import { trigger, transition, state, animate, style, AnimationEvent } from '@ang
3333
transition('closed => open', [
3434
animate('0.5s')
3535
]),
36-
// #enddocregion transition2, trigger, component
36+
// #enddocregion transition2, component
3737
// #docregion trigger-wildcard1
3838
transition('* => closed', [
3939
animate('1s')
@@ -54,15 +54,14 @@ import { trigger, transition, state, animate, style, AnimationEvent } from '@ang
5454
),
5555
]),
5656
// #enddocregion transition4
57-
// #docregion transition3
5857
transition('* => *', [
5958
animate('1s')
6059
]),
61-
// #enddocregion transition3, trigger-transition
62-
// #docregion trigger, component, trigger-wildcard1, events1
60+
// #enddocregion trigger-transition
61+
// #docregion component, trigger-wildcard1, events1
6362
]),
6463
],
65-
// #enddocregion trigger, trigger-wildcard1
64+
// #enddocregion trigger-wildcard1
6665
templateUrl: 'open-close.component.html',
6766
styleUrls: ['open-close.component.css']
6867
})

aio/content/examples/architecture/src/app/app.component.ts

-2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,4 @@ import { Component } from '@angular/core';
99
<app-sales-tax></app-sales-tax>
1010
`
1111
})
12-
// #docregion export
1312
export class AppComponent { }
14-
// #enddocregion export

aio/content/examples/architecture/src/app/app.module.ts

-2
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,11 @@ import { Logger } from './logger.service';
2222
HeroListComponent,
2323
SalesTaxComponent
2424
],
25-
// #docregion providers
2625
providers: [
2726
BackendService,
2827
HeroService,
2928
Logger
3029
],
31-
// #enddocregion providers
3230
bootstrap: [ AppComponent ]
3331
})
3432
// #docregion export

aio/content/examples/architecture/src/app/mini-app.ts

-4
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ export class Logger {
77
log(message: string) { console.log(message); }
88
}
99

10-
// #docregion import-core-component
1110
import { Component } from '@angular/core';
12-
// #enddocregion import-core-component
1311

1412
@Component({
1513
selector: 'app-root',
@@ -35,9 +33,7 @@ import { BrowserModule } from '@angular/platform-browser';
3533
exports: [ AppComponent ],
3634
bootstrap: [ AppComponent ]
3735
})
38-
// #docregion export
3936
export class AppModule { }
40-
// #enddocregion export
4137
// #enddocregion module
4238

4339
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';

aio/content/examples/attribute-binding/src/app/app.component.html

-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11

22
<h1>Attribute, class, and style bindings</h1>
33
<h2>Attribute binding</h2>
4-
<!-- #docregion attrib-binding-colspan -->
54
<table border=1>
65
<!-- #docregion colspan -->
76
<!-- expression calculates colspan=2 -->
@@ -18,7 +17,6 @@ <h2>Attribute binding</h2>
1817

1918
<tr><td>Five</td><td>Six</td></tr>
2019
</table>
21-
<!-- #enddocregion attrib-binding-colspan -->
2220

2321
<div>
2422
<!-- #docregion attrib-binding-aria -->

aio/content/examples/attribute-directives/src/app/highlight.directive.2.ts

+1-6
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,14 @@ export class HighlightDirective {
1414
constructor(private el: ElementRef) { }
1515
// #enddocregion ctor
1616

17-
// #docregion mouse-methods, host
17+
// #docregion mouse-methods
1818
@HostListener('mouseenter') onMouseEnter() {
19-
// #enddocregion host
2019
this.highlight('yellow');
21-
// #docregion host
2220
}
2321

2422
@HostListener('mouseleave') onMouseLeave() {
25-
// #enddocregion host
2623
this.highlight(null);
27-
// #docregion host
2824
}
29-
// #enddocregion host
3025

3126
private highlight(color: string) {
3227
this.el.nativeElement.style.backgroundColor = color;

aio/content/examples/bootstrapping/src/app/app.module.ts

-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
// #docplaster
2-
// #docregion whole-ngmodule
3-
42
// imports
53
import { BrowserModule } from '@angular/platform-browser';
64
import { NgModule } from '@angular/core';
@@ -32,5 +30,3 @@ import { ItemDirective } from './item.directive';
3230
bootstrap: [AppComponent]
3331
})
3432
export class AppModule { }
35-
36-
// #enddocregion whole-ngmodule
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import { Component, Input } from '@angular/core';
22
import { Hero } from './hero';
33

4-
// #docregion styleurls
54
@Component({
65
selector: 'app-hero-details',
76
template: `
@@ -12,7 +11,5 @@ import { Hero } from './hero';
1211
styleUrls: ['./hero-details.component.css']
1312
})
1413
export class HeroDetailsComponent {
15-
// #enddocregion styleurls
1614
@Input() hero: Hero;
17-
// #docregion styleurls
1815
}

aio/content/examples/component-styles/src/app/quest-summary.component.ts

-2
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,8 @@ import { Component, ViewEncapsulation } from '@angular/core';
55
// #docregion
66
@Component({
77
selector: 'app-quest-summary',
8-
// #docregion urls
98
templateUrl: './quest-summary.component.html',
109
styleUrls: ['./quest-summary.component.css']
11-
// #enddocregion urls
1210
})
1311
export class QuestSummaryComponent { }
1412
// #enddocregion
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,18 @@
1-
// #docregion
21
import { Component } from '@angular/core';
32

4-
// #docregion import-services
53
import { LoggerService } from './logger.service';
64
import { UserContextService } from './user-context.service';
7-
import { UserService } from './user.service';
85

96
@Component({
107
selector: 'app-root',
118
templateUrl: './app.component.html',
129
})
1310
export class AppComponent {
14-
// #enddocregion import-services
1511

1612
private userId = 1;
1713

18-
// #docregion ctor
1914
constructor(logger: LoggerService, public userContext: UserContextService) {
2015
userContext.loadUser(this.userId);
2116
logger.logInfo('AppComponent initialized');
2217
}
23-
// #enddocregion ctor
24-
// #docregion import-services
2518
}
26-
// #enddocregion import-services

aio/content/examples/dependency-injection-in-action/src/app/date-logger.service.ts

-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ import { LoggerService } from './logger.service';
88
@Injectable({
99
providedIn: 'root'
1010
})
11-
// #docregion date-logger-service-signature
1211
export class DateLoggerService extends LoggerService
13-
// #enddocregion date-logger-service-signature
1412
{
1513
logInfo(msg: any) { super.logInfo(stamp(msg)); }
1614
logDebug(msg: any) { super.logInfo(stamp(msg)); }

aio/content/examples/dependency-injection-in-action/src/app/hero-bios.component.ts

-4
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,9 @@ import { LoggerService } from './logger.service';
1717
})
1818
export class HeroBiosComponent {
1919
// #enddocregion simple
20-
// #docregion ctor
2120
constructor(logger: LoggerService) {
2221
logger.logInfo('Creating HeroBiosComponent');
2322
}
24-
// #enddocregion ctor
2523
// #docregion simple
2624
}
2725
// #enddocregion simple
@@ -36,9 +34,7 @@ export class HeroBiosComponent {
3634
<app-hero-bio [heroId]="2"> <app-hero-contact></app-hero-contact> </app-hero-bio>
3735
<app-hero-bio [heroId]="3"> <app-hero-contact></app-hero-contact> </app-hero-bio>`,
3836
// #enddocregion template
39-
// #docregion class-provider
4037
providers: [HeroService]
41-
// #enddocregion class-provider
4238
})
4339
export class HeroBiosAndContactsComponent {
4440
constructor(logger: LoggerService) {

aio/content/examples/dependency-injection-in-action/src/app/hero-contact.component.ts

-2
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,7 @@ export class HeroContactComponent {
3030
this.hasLogger = true;
3131
loggerService.logInfo('HeroContactComponent can log!');
3232
}
33-
// #docregion ctor
3433
}
35-
// #enddocregion ctor
3634

3735
get phoneNumber() { return this.heroCache.hero.phone; }
3836

aio/content/examples/dependency-injection-in-action/src/app/hero-of-the-month.component.ts

-2
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,11 @@ const someHero = new Hero(42, 'Magma', 'Had a great month!', '555-555-5555');
4848
export class HeroOfTheMonthComponent {
4949
logs: string[] = [];
5050

51-
// #docregion ctor-signature
5251
constructor(
5352
logger: MinimalLogger,
5453
public heroOfTheMonth: Hero,
5554
@Inject(RUNNERS_UP) public runnersUp: string,
5655
@Inject(TITLE) public title: string)
57-
// #enddocregion ctor-signature
5856
{
5957
this.logs = logger.logs;
6058
logger.logInfo('starting up');

aio/content/examples/dependency-injection-in-action/src/app/parent-finder.component.ts

+2-6
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ export function provideTheParent
3535

3636

3737
///////// C - Child //////////
38-
// #docregion carol
3938
const templateC = `
4039
<div class="c">
4140
<h3>{{name}}</h3>
@@ -54,7 +53,6 @@ export class CarolComponent {
5453
// #enddocregion carol-ctor
5554
}
5655
// #enddocregion carol-class
57-
// #enddocregion carol
5856

5957
@Component({
6058
selector: 'chris',
@@ -132,7 +130,7 @@ export class BethComponent implements Parent {
132130

133131
///////// A - Grandparent //////
134132

135-
// #docregion alex, alex-1
133+
// #docregion alex-1
136134
@Component({
137135
selector: 'alex',
138136
template: `
@@ -157,11 +155,10 @@ export class AlexComponent extends Base
157155
{
158156
name = 'Alex';
159157
}
160-
// #enddocregion alex, alex-1
158+
// #enddocregion alex-1
161159

162160
/////
163161

164-
// #docregion alice
165162
@Component({
166163
selector: 'alice',
167164
template: `
@@ -182,7 +179,6 @@ export class AliceComponent implements Parent
182179
{
183180
name = 'Alice';
184181
}
185-
// #enddocregion alice
186182

187183
////// Cathy ///////////
188184
/**

aio/content/examples/dependency-injection-in-action/src/app/runners-up.ts

-2
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@ import { InjectionToken } from '@angular/core';
55
import { Hero } from './hero';
66
import { HeroService } from './hero.service';
77

8-
// #docregion runners-up
98
export const RUNNERS_UP = new InjectionToken<string>('RunnersUp');
10-
// #enddocregion runners-up
119

1210
// #docregion factory-synopsis
1311
export function runnersUpFactory(take: number) {

0 commit comments

Comments
 (0)