Skip to content

Commit 2842047

Browse files
authored
docs: Page with explicitly states supported features (#36)
1 parent d7f3444 commit 2842047

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

docs/astro.config.mjs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ export default defineConfig({
3030
label: 'Getting Started',
3131
items: [
3232
{ label: 'Installation', link: '/' },
33-
{ label: 'Usage', slug: 'getting-started/usage' },
33+
{ slug: 'getting-started/usage' },
34+
{ slug: 'getting-started/supported-features' },
3435
{ label: 'Changelog', link: 'changelog' },
3536
],
3637
},
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Supported Features
3+
---
4+
5+
Most native reflection features and most PHPDoc (or, rather PHPStan) features are supported. Here's a full list:
6+
7+
- reflecting classes, interfaces, traits enums
8+
- reflecting anonymous classes
9+
- reflecting properties and methods
10+
- `@template`, `@template-covariant`, `@template-contravariant`, upper bound (`of string`) and
11+
default values (`= string`) - in classes and methods
12+
- `@extends`, `@implements` and `@use`
13+
- `@var` for properties and promoted properties
14+
- `@param` for method parameters and promoted properties
15+
- `@return` for method returns
16+
- `@phpstan-` and `@psalm-` versions of all tags - with precedence
17+
- all native types, template (generic) types and array tuples
18+
19+
## What isn't supported, but would be welcomed
20+
21+
- reflecting functions
22+
- function/method return type inference from arguments
23+
- conditional types
24+
- type aliases (local and imported)
25+
- some other PHPDoc tags

0 commit comments

Comments
 (0)