use-php-docblock 0.0.1

PHPDoc block metadata primitives for RustUse.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

# use-php-docblock

PHPDoc block metadata primitives for `RustUse`.

## Experimental

`use-php-docblock` is experimental while `use-php` remains below `0.3.0`.

## Example

```rust
use use_php_docblock::{Docblock, DocblockTag, DocblockTagKind, TagName};

let block = Docblock::new("/**\n * Create a user.\n *\n * Stores metadata only.\n */")?;
let tag = DocblockTag::new(TagName::new("return")?).with_kind(DocblockTagKind::Return);

assert_eq!(block.summary(), "Create a user.");
assert_eq!(tag.kind(), Some(DocblockTagKind::Return));
# Ok::<(), use_php_docblock::PhpDocblockError>(())
```

## Scope

- PHPDoc summary/body metadata, common tag labels, tag names, and type-string wrappers.

## Non-goals

- Complete PHPDoc parsing, type-expression parsing, inheritance, or analyzer-specific dialects.

## License

Licensed under either Apache-2.0 or MIT.