29b665f7ad
docs(docs-infra): fix entry labels. ( #59384 )
...
fixes #59382
PR Close #59384
2025-01-08 15:22:43 +00:00
ede700731b
docs: update README to reflect correct Angular repository branch in rendering regions ( #59421 )
...
PR Close #59421
2025-01-08 15:22:07 +00:00
99b2646af6
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:43 +00:00
6807072feb
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
3af585b98e
docs(docs-infra): enable tslint ( #58961 )
...
PR Close #58961
2024-12-05 16:03:36 -08:00
7ad1f27d83
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:06:00 +01:00
e18adff76d
refactor(docs-infra): update comments ( #59004 )
...
Add missing file header comments and update others.
PR Close #59004
2024-12-04 18:06:00 +01:00
6338c1bece
test(docs-infra): interpolation mechanism ( #59004 )
...
Test all use cases that are supported by the interpolation mechanism.
PR Close #59004
2024-12-04 18:06:00 +01:00
54a1bcee20
fix(docs-infra): minor bug fixes ( #59004 )
...
Minor bug fixes found and implemented during testing.
PR Close #59004
2024-12-04 18:06:00 +01:00
dc8fd113a5
test(docs-infra): add initial test ( #59004 )
...
Setup the test suite and add the initial test.
PR Close #59004
2024-12-04 18:05:59 +01:00
e0aa93e67f
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:59 +01:00
7e4d312aed
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:59 +01:00
8eb20463bf
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:59 +01:00
d75c4d2d12
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:59 +01:00
3c0e4938a7
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:59 +01:00
41a600f3ae
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:59 +01:00
9a87aa398b
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
499b227e11
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:06 +00:00
791ee323dc
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:09 +00:00
4bebc9d5e4
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:09 +00:00
671fafac95
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:55 +00:00
65a0a1d416
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:15 +00:00
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
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
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
49f7179ded
docs(docs-infra): Add dedicated support for decorators. ( #57595 )
...
PR Close #57595
2024-09-19 14:16:31 -07:00
dbdd7875dd
docs: Enable direct links to class/interface methods for @link ( #57615 )
...
PR Close #57615
2024-09-06 16:03:36 +00:00
9624ab03c9
docs(docs-infra): fix extraction tests ( #57694 )
...
PR Close #57694
2024-09-06 15:07:47 +00:00
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
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
1b7571f404
docs(docs-infra): enable tests for api-gen ( #57618 )
...
PR Close #57618
2024-09-05 14:05:04 +00:00
a84cecfc99
docs(docs-infra): add support for extends/implements on API entries ( #57588 )
...
PR Close #57588
2024-09-03 07:47:25 -07:00
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
b96e75b89a
docs(docs-infra): Improve styling around API pages ( #57492 )
...
PR Close #57492
2024-08-30 11:12:25 -07:00
55387c5b56
docs(docs-infra): Improve support for deprecated methods ( #57492 )
...
PR Close #57492
2024-08-30 11:12:25 -07:00
01030d58a7
docs(docs-infra): Add support for cross-links on API pages ( #57346 )
...
PR Close #57346
2024-08-29 13:39:58 -07:00
6c2beba63d
docs(docs-infra): Add dev-mode only mention for core/global ( #57365 )
...
PR Close #57365
2024-08-29 10:17:35 -07:00
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
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
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
9857570165
docs(docs-infra): fix markdown link rendering ( #57377 )
...
fixes #57376
PR Close #57377
2024-08-13 15:53:55 -07:00
04911d7599
docs(docs-infra): Add support for function/method overloads ( #57255 )
...
PR Close #57255
2024-08-13 12:09:01 -07:00
360979f37e
docs(docs-infra): fix marked rendering ( #57338 )
...
Follow-up to #57319 which introduced some regressions after updating marked to v14
PR Close #57338
2024-08-12 11:19:51 -07:00
2c321a0f7f
build: update dependency marked to v14 ( #57319 )
...
See associated pull request for more information.
Closes #57283 as a pr takeover
PR Close #57319
2024-08-09 08:04:04 -07:00
3bdead1b2f
refactor(docs-infra): migrate api-gen from dev-infra into the repo ( #57241 )
...
Move the api-gen pipeline into the shared-docs directory.
PR Close #57241
2024-08-05 17:06:29 +00:00
Matthieu Riegler