Elgato_dark/angular
1
0
Fork 0
mirror of https://github.com/angular/angular synced 2026-05-24 09:28:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
32413 commits 106 branches 1260 tags 1 GiB
Commit graph

54 commits

Author SHA1 Message Date
Matthieu Riegler
db5963797d docs(docs-infra): Extract class constructors (#60302) 
fixes #59180

PR Close #60302
 2025-03-10 16:05:02 -07:00
Matthieu Riegler
aa1ab41e6c docs(docs-infra): enable & fix tests (#60220) 
PR Close #60220
 2025-03-06 14:33:48 -08:00
Matthieu Riegler
286e4da52b docs(docs-infra): Throw error at build time for invalid links (#59162) 
PR Close #59162
 2025-03-04 20:07:23 +00:00
hawkgs
2b114e784d docs(docs-infra): API doc content rendering fixes (#60116) 
The PR introduces a few doc content rendering fixes:
- Fix highlighted section heading styles (regression from #59965).
- Convert JSDoc links within 'Usage Notes' sections to HTML and render them.
- Add IDs to doc content headings. This, by itself, makes these headings available in the page ToC.

PR Close #60116
 2025-03-04 17:46:30 +00:00
Miles Malerba
2e03a8685b docs(docs-infra): Improve support for @link within the jsdoc. (#60201) 
PR Close #60201
 2025-03-04 17:13:42 +00:00
Matthieu Riegler
ba94f6f84f docs(docs-infra): hide github link for external repos. (#60114) 
fixes #60113

PR Close #60114
 2025-03-04 17:02:37 +00:00
hawkgs
ea5b7371e5 docs(docs-infra): fix card highlighting in the API reference details page (#59965) 
Drop `pointer-events: none` and update the member card highlighting mechanism.

PR Close #59965
 2025-02-18 14:56:48 +00:00
hawkgs
b6733eeea4 docs(docs-infra): drop tabs layout from the API reference details page (#59068) 
Drop the tabs in favor of a single page separated by sections.

PR Close #59068
 2025-02-13 14:58:33 +00:00
Matthieu Riegler
0d88463a66 docs(docs-infra): inline example in description (#59908) 
fixes #59905

PR Close #59908
 2025-02-12 09:21:49 -08:00
Matthieu Riegler
fd073004bb docs(docs-infra): fix entry labels. (#59384) 
fixes #59382

PR Close #59384
 2025-01-08 15:22:43 +00:00
RafaelJCamara
fabd642826 docs: update README to reflect correct Angular repository branch in rendering regions (#59421) 
PR Close #59421
 2025-01-08 15:22:07 +00:00
Matthieu Riegler
139f61913c docs: remove data attributes from api-item-label (#59273) 
Perf measurments have revealed that `data-*` attributes are slower to set than classes.

PR Close #59273
 2025-01-06 16:03:42 +00:00
Matthieu Riegler
cf27cbb1f8 docs(docs-infra): remove costly localeCompare (#59106) 
This function wasn't necessary, the items where already sorted.

fixes #59069d

PR Close #59106
 2024-12-16 15:18:39 -08:00
Matthieu Riegler
f15ccb94b9 docs(docs-infra): enable tslint (#58961) 
PR Close #58961
 2024-12-05 16:03:35 -08:00
hawkgs
77a0ee85c1 feat(docs-infra): use angular-ts and angular-html shiki highlighting (#59004) 
Use `angular-ts` instead of `typescript` and `angular-html` instead of `html`.

PR Close #59004
 2024-12-04 18:05:59 +01:00
hawkgs
0a399e7f9c refactor(docs-infra): update comments (#59004) 
Add missing file header comments and update others.

PR Close #59004
 2024-12-04 18:05:59 +01:00
hawkgs
c13528b1b9 test(docs-infra): interpolation mechanism (#59004) 
Test all use cases that are supported by the interpolation mechanism.

PR Close #59004
 2024-12-04 18:05:58 +01:00
hawkgs
d40967c356 fix(docs-infra): minor bug fixes (#59004) 
Minor bug fixes found and implemented during testing.

PR Close #59004
 2024-12-04 18:05:58 +01:00
hawkgs
b97b92024d test(docs-infra): add initial test (#59004) 
Setup the test suite and add the initial test.

PR Close #59004
 2024-12-04 18:05:58 +01:00
hawkgs
9ca8ddb265 fix(docs-infra): markdown code block highlighting for the different file types (#59004) 
Set the code block language highlighting based on the file type.

PR Close #59004
 2024-12-04 18:05:58 +01:00
hawkgs
f13f52f70f feat(docs-infra): remove redundant JSDoc transform related to code examples (#59004) 
The transform is no longer relevant nor it served any functional purpose.

PR Close #59004
 2024-12-04 18:05:58 +01:00
hawkgs
e1009f09c0 fix(docs-infra): handle regions overlap and multiple-regions examples (#59004) 
It seems that there are overlapping region markers and an example can be composed by multiple regions.

PR Close #59004
 2024-12-04 18:05:58 +01:00
hawkgs
e0beb27581 fix(docs-infra): interpolation script nesting (#59004) 
Add support for nested #docregion-s and modify the examples caching.

PR Close #59004
 2024-12-04 18:05:58 +01:00
hawkgs
8b93e3c90d feat(docs-infra): implement interpolation script (#59004) 
The script substitutes the JSDoc example tags with the respective code sample.

PR Close #59004
 2024-12-04 18:05:58 +01:00
hawkgs
a4ee2d90e6 feat(docs-infra): include code examples files in the API gen (#59004) 
The code examples in `package/examples` are now passed to the API JSON generator.

PR Close #59004
 2024-12-04 18:05:58 +01:00
Matthieu Riegler
d0ea622040 docs(docs-infra): read jsdoctags from function overloads (#58994) 
Functions like `linkedSignal` have there `@developerPreview` tags on the overload signature. This commit adds the support for them.

This commit also removes the logic for multiple entries, as now overloads are a single entry.

fixes #58817

PR Close #58994
 2024-12-02 16:17:02 +01:00
Alan Agius
c2a9b75045 fix(docs-infra): retain function keyword in API definitions (#58561) 
**Before:**
```ts
animate(
  timings: string | number,
  styles?: AnimationStyleMetadata | AnimationKeyframesSequenceMetadata | null
): AnimationAnimateMetadata;
```

**Now:**
```ts
function animate(
  timings: string | number,
  styles?: AnimationStyleMetadata | AnimationKeyframesSequenceMetadata | null
): AnimationAnimateMetadata;
```

PR Close #58561
 2024-11-08 17:16:04 +00:00
Alan Agius
d271c4422a fix(compiler-cli): correct extraction of generics from type aliases (#58548) 
**Before:**
```ts
type HttpEvent = | HttpSentEvent
  | HttpHeaderResponse
  | HttpResponse<T>
  | HttpProgressEvent
  | HttpUserEvent<T>
```

**After:**
```ts
type HttpEvent<T> = | HttpSentEvent
  | HttpHeaderResponse
  | HttpResponse<T>
  | HttpProgressEvent
  | HttpUserEvent<T>
```

PR Close #58548
 2024-11-08 17:15:06 +00:00
Alan Agius
c95aca1f17 docs(docs-infra): update default generic values and add constraints for type parameters in functions (#58548) 
Before
```typescript
createNodeRequestHandler(
  handler: T
): T;
```

```typescript
class NgIf<T> {
  @Input() set ngIf(value: T);
  @Input() set ngIfThen(value: TemplateRef<NgIfContext<T>> | null);
  @Input() set ngIfElse(value: TemplateRef<NgIfContext<T>> | null);
  static ngTemplateGuard_ngIf: "binding";
  static ngTemplateContextGuard<T>(dir: NgIf<T>, ctx: any): boolean;
}
```

Now
```typescript
createNodeRequestHandler<T extends NodeRequestHandlerFunction>(
  handler: T
): T;
```

```typescript
class NgIf<T = unknown> {
  @Input() set ngIf(value: T);
  @Input() set ngIfThen(value: TemplateRef<NgIfContext<T>> | null);
  @Input() set ngIfElse(value: TemplateRef<NgIfContext<T>> | null);
  static ngTemplateGuard_ngIf: "binding";
  static ngTemplateContextGuard<T>(dir: NgIf<T>, ctx: any): boolean;
}
```

PR Close #58548
 2024-11-08 17:15:06 +00:00
Alan Agius
3ecf0f6701 docs: add hybrid rendering API guide (#58445) 
This commit introduces a new guide for hybrid rendering APIs, which are currently in developer preview. This documentation provides insights into the usage and features of the APIs, helping developers understand their capabilities and limitations during the preview phase.

PR Close #58445
 2024-11-07 21:28:54 +00:00
Alan Agius
c5ce302e0b docs(docs-infra): add support for @remarks (#58523) 
In TSDoc, we currently handle the `@usageNotes` annotation, but this is not a standard TSDoc tag. Instead, the `@remarks` annotation is the correct standard, which is used in the Angular CLI repo and on the SSR package.

This change ensures that `@remarks` is treated the same as `@usageNotes` during the transform process.

PR Close #58523
 2024-11-07 15:49:13 +00:00
Matthieu Riegler
c1aa9c6041 docs(docs-infra): fix CLI commands (#58294) 
With this commit the CLI doc will display the correct arguments for the subcommands

fixes #58279

PR Close #58294
 2024-10-22 07:42:21 -07:00
Matthieu Riegler
bb0edaded0 docs(docs-infra): Add NgModule exports for directives. (#58071) 
This information is extracted from the @NgModule Jsdoc tag.

fixes #57906

PR Close #58071
 2024-10-04 14:46:16 -07:00
Joey Perrott
9dbe6fc18b refactor: update license text to point to angular.dev (#57901) 
Update license text to point to angular.dev instead of angular.io

PR Close #57901
 2024-09-24 15:33:00 +02:00
Matthieu Riegler
49f7179ded docs(docs-infra): Add dedicated support for decorators. (#57595) 
PR Close #57595
 2024-09-19 14:16:31 -07:00
Matthieu Riegler
dbdd7875dd docs: Enable direct links to class/interface methods for @link (#57615) 
PR Close #57615
 2024-09-06 16:03:36 +00:00
Matthieu Riegler
9624ab03c9 docs(docs-infra): fix extraction tests (#57694) 
PR Close #57694
 2024-09-06 15:07:47 +00:00
Matthieu Riegler
1698bd3ed8 refactor(compiler-cli): Do extract symbols from private modules. (#57611) 
Modules like `core/primitives` are considered private and their symbols shouldn't be exposed nor linked in the docs.

PR Close #57611
 2024-09-06 14:15:18 +00:00
Matthieu Riegler
e3919e7b9d docs: display property details (#57622) 
In case there are no signatures (like in an bare interface method), we display the implementation information.

PR Close #57622
 2024-09-05 17:22:32 +00:00
Matthieu Riegler
1b7571f404 docs(docs-infra): enable tests for api-gen (#57618) 
PR Close #57618
 2024-09-05 14:05:04 +00:00
Matthieu Riegler
a84cecfc99 docs(docs-infra): add support for extends/implements on API entries (#57588) 
PR Close #57588
 2024-09-03 07:47:25 -07:00
Matthieu Riegler
b031b640b9 docs(docs-infra): Add set of unit tests to the API markdown parsing (#57492) 
PR Close #57492
 2024-08-30 11:12:25 -07:00
Matthieu Riegler
b96e75b89a docs(docs-infra): Improve styling around API pages (#57492) 
PR Close #57492
 2024-08-30 11:12:25 -07:00
Matthieu Riegler
55387c5b56 docs(docs-infra): Improve support for deprecated methods (#57492) 
PR Close #57492
 2024-08-30 11:12:25 -07:00
Matthieu Riegler
01030d58a7 docs(docs-infra): Add support for cross-links on API pages (#57346) 
PR Close #57346
 2024-08-29 13:39:58 -07:00
Matthieu Riegler
6c2beba63d docs(docs-infra): Add dev-mode only mention for core/global (#57365) 
PR Close #57365
 2024-08-29 10:17:35 -07:00
Matthieu Riegler
e404f88092 docs(docs-infra): show usageNotes only for methods. (#57343) 
Prior to this change, function and methods showed their usage notes which resulted in duplicate displays for functions.

Fixes #57339

PR Close #57343
 2024-08-29 07:39:50 -07:00
Matthieu Riegler
cb3128d925 docs(docs-infra): fix regressions around members & deprecations (#57465) 
This commit fixes regressions introduced by #57255

PR Close #57465
 2024-08-21 11:26:26 -07:00
Matthieu Riegler
b87bbf6c95 docs(docs-infra): Add tests for marked rendering (#57344) 
On top of #57338, to make sure we prevent similar regressions on marked rendering.

PR Close #57344
 2024-08-19 09:21:16 -07:00
Matthieu Riegler
9857570165 docs(docs-infra): fix markdown link rendering (#57377) 
fixes #57376

PR Close #57377
 2024-08-13 15:53:55 -07:00