Skip to content

Commit

Permalink
fix(php): Improve multiline parameter documentation (#5892)
Browse files Browse the repository at this point in the history
  • Loading branch information
amckinney authored Feb 5, 2025
1 parent 9a5a88e commit 405d6ff
Show file tree
Hide file tree
Showing 234 changed files with 5,147 additions and 55 deletions.
15 changes: 15 additions & 0 deletions fern/pages/changelogs/php-sdk/2025-02-05.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## 0.3.1
**`(fix):`** Improve multiline parameter docs by writing them above the tag, e.g.
```php class UpdateUserRequest extends JsonSerializableType {
/**
* The user to update.
*
* See [User](https://acme.co/user) for more information.
*
* @var ?User $user
*/
public ?User $user;
} ```

**`(fix):`** Add .idea to the generated .gitignore file.

1 change: 1 addition & 0 deletions generators/php/codegen/src/asIs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.idea
.php-cs-fixer.cache
.phpunit.result.cache
composer.lock
Expand Down
14 changes: 12 additions & 2 deletions generators/php/codegen/src/ast/Comment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,24 @@ export class Comment extends AstNode {
}

private writeTag({ writer, tag }: { writer: Writer; tag: Comment.Tag }): void {
const docsSplit = tag.docs != null ? tag.docs.split("\n") : undefined;
if (docsSplit != null && docsSplit.length > 1) {
docsSplit.forEach((line) => {
writer.writeLine(` * ${line}`);
});
writer.writeLine(` *`);

Check failure on line 72 in generators/php/codegen/src/ast/Comment.ts

View workflow job for this annotation

GitHub Actions / eslint

Strings must use doublequote
}

writer.write(` * @${tag.tagType} `);
tag.type.write(writer, { comment: true });
if (tag.name != null) {
writer.write(` ${tag.name}`);
}
if (tag.docs != null) {
writer.write(` ${tag.docs}`);

if (docsSplit != null && docsSplit.length === 1) {
writer.write(` ${docsSplit[0]}`);
}

writer.newLine();
}
}
23 changes: 23 additions & 0 deletions generators/php/sdk/versions.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
- version: 0.3.1
changelogEntry:
- type: fix
summary: >-
Improve multiline parameter docs by writing them above the tag, e.g.
```php
class UpdateUserRequest extends JsonSerializableType
{
/**
* The user to update.
*
* See [User](https://acme.co/user) for more information.
*
* @var ?User $user
*/
public ?User $user;
}
```
- type: fix
summary: >-
Add .idea to the generated .gitignore file.
irVersion: 53
- version: 0.3.0
changelogEntry:
- type: feat
Expand Down
48 changes: 48 additions & 0 deletions seed/php-model/accept-header/.github/workflows/ci.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions seed/php-model/accept-header/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions seed/php-model/accept-header/.mock/definition/api.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 16 additions & 0 deletions seed/php-model/accept-header/.mock/definition/service.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions seed/php-model/accept-header/.mock/fern.config.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions seed/php-model/accept-header/.mock/generators.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

40 changes: 40 additions & 0 deletions seed/php-model/accept-header/composer.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions seed/php-model/accept-header/phpstan.neon

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions seed/php-model/accept-header/phpunit.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Empty file.
Empty file.
161 changes: 161 additions & 0 deletions seed/php-model/accept-header/src/Core/Json/JsonDecoder.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 405d6ff

Please sign in to comment.