Skip to main content

Module phpdoc

Module phpdoc 

Source
Expand description

PHPDoc comment parser.

Parses /** ... */ doc-block comments into a structured PhpDoc representation with summary, description, and typed tags.

§Usage

let text = "/** @param int $x The value */";
let doc = php_rs_parser::phpdoc::parse(text);
assert_eq!(doc.tags.len(), 1);

Structs§

PhpDoc
A parsed PHPDoc block (/** ... */).

Enums§

PhpDocTag
A single PHPDoc tag (e.g. @param int $x The value).

Functions§

parse
Parse a raw doc-comment string into a PhpDoc.