Skip to content

Commit 5afa64f

Browse files
committed
Actualize readme
1 parent 37c8d29 commit 5afa64f

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

libs/phpdoc/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,8 @@ its description.
216216

217217
- [x] `@abstract` — Declare any _Element_ as abstract
218218
> `"@abstract" [ <Description> ]`
219+
- [x] `@access` — Documents the visibility (access level) of an _Element_
220+
> `"@access" ( "public" | "protected" | "private" ) [ <Description> ]`
219221
- [x] `@api` — Highlight _Element_ as being part of the public API
220222
> `"@api" [ <Description> ]`
221223
- [x] `@author` — Documents the author of an _Element_, together with an optional email address
@@ -236,6 +238,8 @@ its description.
236238
> `"@final" [ <Description> ]`
237239
- [x] `@global` — Documents a global variable that a function relies on
238240
> `"@global" <Type> <Variable> [ <Description> ]`
241+
- [ ] `@id` — Assigns a unique identifier to a tutorial section for use in `@tutorial` links
242+
> `"@id" <Description>`
239243
- [x] `@ignore` — Tells documentation systems that an _Element_ is not to be processed
240244
> `"@ignore" [ <Description> ]`
241245
- [x] `@implements` — Allows to extend templated interfaces
@@ -254,6 +258,8 @@ its description.
254258
> `"@method" [ "static" ] <Type> <Name> "(" [ <Type> <Variable> { "," <Type> <Variable> } ] ")" [ <Description> ]`
255259
- [x] `@mixin` — Declares that the members of the referenced _Type_ are magically available on the described class
256260
> `"@mixin" <Type> [ <Description> ]`
261+
- [x] `@name` — Assigns an alias to a procedural page or global variable
262+
> `"@name" <Name> [ <Description> ]`
257263
- [x] `@no-named-arguments` — Indicates that argument names may change in the future
258264
> `"@no-named-arguments" [ <Description> ]`
259265
- [x] `@package` — Categorizes _Element(s)_ into logical subdivisions
@@ -298,6 +304,10 @@ its description.
298304
> `"@since" [ <Version> ] [ <Description> ]`
299305
- [x] `@source` — Points at a range of lines of the documented _Element_'s source
300306
> `"@source" <Start> [ <Count> ] [ <Description> ]`
307+
- [x] `@static` — Declares a method or property as static
308+
> `"@static" [ <Description> ]`
309+
- [x] `@staticvar` — Documents the _Type_ of a static variable declared within a function or method
310+
> `"@staticvar" <Type> [ <Variable> ] [ <Description> ]`
301311
- [x] `@subpackage` — Categorizes _Element(s)_ into logical subdivisions
302312
> `"@subpackage" [ <Description> ]`
303313
- [x] `@suppress` — Silences the diagnostics that would otherwise be reported for an _Element_
@@ -320,8 +330,12 @@ its description.
320330
> `"@throw" <Type> [ <Description> ]`
321331
- [x] `@throws` — Indicates the type of `\Throwable` an _Element_ may throw
322332
> `"@throws" <Type> [ <Description> ]`
333+
- [ ] `@toc` — Generates a table of contents for a tutorial
334+
> `"@toc" [ <Description> ]`
323335
- [x] `@todo` — Records a task that still needs to be done for an _Element_
324336
> `"@todo" [ <Description> ]`
337+
- [ ] `@tutorial` — Associates a tutorial or extended documentation resource with an _Element_
338+
> `"@tutorial" <URI> [ <Description> ]`
325339
- [x] `@unused-param` — Marks an argument that is intentionally left unused
326340
> `"@unused-param" <Variable> [ <Description> ]`
327341
- [x] `@use` — An alias of the `@template-use` tag

0 commit comments

Comments
 (0)