3d8f827ec7
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:05 +00:00
4c38160853
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:08 +00:00
9199dd9a87
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:07 +00:00
5a236c2c5c
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:14 +00:00
7e933d8486
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:22 -07:00
0e225ce16b
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:17 -07:00
4875bc3073
fix(docs-infra): update getAnswerFiles to ensure compatibility with non-POSIX file systems ( #57970 )
...
This update modifies the `getAnswerFiles` function to support file systems that do not adhere to POSIX standards.
Prior to this change this method will always fail with the below:
```
Error: Invalid state: could not find start of answers path
```
PR Close #57970
2024-09-26 14:29:45 -07:00
dbf15c8f34
fix(docs-infra): extend the timeout for jasmine tests of mermaid ( #57948 )
...
Extend the timeout because mermaid takes too long for the default.
PR Close #57948
2024-09-24 13:02:53 -07:00
03ac3c299d
refactor: update license text to point to angular.dev ( #57902 )
...
Update license text to point to angular.dev instead of angular.io
PR Close #57902
2024-09-24 15:28:46 +02:00
1825460fc3
fix(docs-infra): resolve Mermaid from Bazel root path ( #57924 )
...
This update addresses a build failure on Windows caused by the previous method, which was incompatible with the Windows environment.
Closes #57920
PR Close #57924
2024-09-23 17:20:54 +02:00
07a485fdba
docs(docs-infra): Add dedicated support for decorators. ( #57595 )
...
PR Close #57595
2024-09-19 14:16:33 -07:00
0843f31474
docs: Enable direct links to class/interface methods for @link ( #57615 )
...
PR Close #57615
2024-09-06 16:03:37 +00:00
bb8e7cea28
docs(docs-infra): fix extraction tests ( #57694 )
...
PR Close #57694
2024-09-06 15:07:48 +00:00
09f2ec0a12
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:19 +00:00
21f67b95b5
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
5014bb5b1c
docs(docs-infra): enable tests for api-gen ( #57618 )
...
PR Close #57618
2024-09-05 14:05:05 +00:00
9c3aeb99bb
docs(docs-infra): add support for extends/implements on API entries ( #57588 )
...
PR Close #57588
2024-09-03 07:47:25 -07:00
d2d72e369c
docs(docs-infra): Add set of unit tests to the API markdown parsing ( #57492 )
...
PR Close #57492
2024-08-30 11:12:26 -07:00
641808fa72
docs(docs-infra): Improve styling around API pages ( #57492 )
...
PR Close #57492
2024-08-30 11:12:26 -07:00
f859d5c156
docs(docs-infra): Improve support for deprecated methods ( #57492 )
...
PR Close #57492
2024-08-30 11:12:26 -07:00
c068045d69
docs(docs-infra): Add support for cross-links on API pages ( #57346 )
...
PR Close #57346
2024-08-29 13:39:59 -07:00
93bdbbc812
docs(docs-infra): Add dev-mode only mention for core/global ( #57365 )
...
PR Close #57365
2024-08-29 10:17:35 -07:00
97fd311b6a
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:51 -07:00
9b6865ec03
docs: add test for i18n code block and fix rendering ( #57210 )
...
PR Close #57210
2024-08-23 12:57:15 -07:00
69b20d8391
docs(docs-infra): fix regressions around members & deprecations ( #57465 )
...
This commit fixes regressions introduced by #57255
PR Close #57465
2024-08-21 11:26:27 -07:00
0979ca0354
docs(docs-infra): Fix heading parsing ( #57386 )
...
fixes #57384
PR Close #57386
2024-08-19 09:24:08 -07:00
b5719ba5eb
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:17 -07:00
b1ed7e2b5f
docs(docs-infra): Add support for function/method overloads ( #57379 )
...
PR Close #57379
2024-08-15 12:12:26 -04:00
e50d239e80
docs(docs-infra): fix markdown link rendering ( #57377 )
...
fixes #57376
PR Close #57377
2024-08-13 15:53:56 -07:00
84752069f2
docs(docs-infra): Update marked to 14 ( #57363 )
...
This is a backport of the marked update and the fix that went with it (#57338 )
PR Close #57363
2024-08-13 09:33: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
f125cd82b4
fix(docs-infra): replace the uses of replaceAll with replace using regex with g flag ( #57232 )
...
Use the g flag in replace to perform a replaceAll
PR Close #57232
2024-08-01 19:17:25 +00:00
a49f7c951f
docs(docs-infra): extract captured group from heading custom id regexp ( #57206 )
...
Backport of angular/dev-infra#2202
PR Close #57206
2024-07-31 16:03:28 +00:00
2d8635d29d
refactor(docs-infra): migrate @angular/docs from dev-infra into adev directory ( #57132 )
...
To increase the ease of development we are moving @angular/docs into the adev directory within this repo. While
we are doing this to improve our development experience in the short term, efforts are also in place
to maintain a division between this @angular/docs (shared) code and adev itself, so that it can be extracted
back out in the future when components is ready to leverage it as well.
PR Close #57132
2024-07-30 15:51:26 +00:00
Alan Agius