protobuf

19179 Commits

204 Branches

369 Tags

184 MiB

Tag: Branch: Tree: 4c34e652cf

Commit Graph

Author SHA1 Message Date

Author	SHA1	Message	Date
Brent Shaffer	f929439ccd	feat: more readable phpdoc escaping (#11208 ) The PHPDoc escaping in PHP is aggressive in that it escapes some character sequences that don't need to be escaped (`/`), and it uses HTML entities to escape others (`/` and `@`) instead of the recommended PHPDoc escape sequences. For Example, in [`Google\Api\RoutingParameter`](https://github.com/googleapis/common-protos-php/blob/main/src/Api/RoutingParameter.php#L42): ``` * path_template: "projects//{table_location=instances/}/tables/" ``` Should be escaped as: ``` path_template: "projects/{@}{table_location=instances/}/tables/" ``` according to [the PHPDoc guide](https://manual.phpdoc.org/HTMLframesConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#basics.desc): - For `@`: "if you need an actual "@" in your DocBlock's description parts, you should be careful to either ensure it is not the first character on a line, or else escape it ("\\@") to avoid it being interpreted as a PhpDocumentor tag marker." - For `/`: " If you need to use the closing comment "\/" in a DocBlock, use the special escape sequence "{@}." Closes #11208 COPYBARA_INTEGRATE_REVIEW=https://github.com/protocolbuffers/protobuf/pull/11208 from bshaffer:more-readable-phpdoc-escaping `a75f9745ea` PiperOrigin-RevId: 603091642	1 year ago

Brent Shaffer

f929439ccd

feat: more readable phpdoc escaping (#11208 )

The PHPDoc escaping in PHP is aggressive in that it escapes some character sequences that don't need to be escaped (`/*`), and it uses HTML entities to escape others (`*/` and `@`) instead of the recommended PHPDoc escape sequences.

For Example, in [`Google\Api\RoutingParameter`](https://github.com/googleapis/common-protos-php/blob/main/src/Api/RoutingParameter.php#L42):

```
 * path_template: "projects/&#42;&#47;{table_location=instances/&#42;}/tables/&#42;"
```

Should be escaped as:

```
 * path_template: "projects/{@*}{table_location=instances/*}/tables/*"
```

according to [the PHPDoc guide](https://manual.phpdoc.org/HTMLframesConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#basics.desc):

 - For `@`: "if you need an actual "@" in your DocBlock's description parts, you should be careful to either ensure it is not the first character on a line, or else escape it ("\\@") to avoid it being interpreted as a PhpDocumentor tag marker."

 - For `*/`: " If you need to use the closing comment "\*/" in a DocBlock, use the special escape sequence "{@*}."

Closes #11208

COPYBARA_INTEGRATE_REVIEW=https://github.com/protocolbuffers/protobuf/pull/11208 from bshaffer:more-readable-phpdoc-escaping a75f9745ea
PiperOrigin-RevId: 603091642

1 year ago

1 Commits (4c34e652cfdb2bc0b205ca82cd81430d4a35d20e)