Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PHPDoc] Improved ContentService doc for API reference #379

Merged
merged 15 commits into from
Nov 5, 2024

Conversation

adriendupuis
Copy link
Contributor

@adriendupuis adriendupuis commented Jun 7, 2024

🎫 Issue N/A

Description:

Enhance ContentService doc:

  • Rewording (e.g. ContentService::loadContent)
  • Format PHPDoc (capitalize description except @thows, trailing period, etc.)
  • Enhance a bit (add few @see, etc.)

PHP API Reference output:

Notice that by inheritance, it also changes the doc for ContentServiceDecorator:

For QA:

Documentation:

@adriendupuis adriendupuis force-pushed the improved_contentservice_phpdoc branch from 0700fc8 to f33c2e7 Compare June 21, 2024 13:20
@adriendupuis adriendupuis changed the base branch from main to 4.6 June 21, 2024 13:20
@adamwojs
Copy link
Member

@adriendupuis Could you please address issues reported by phpstan?

src/contracts/Repository/ContentService.php Outdated Show resolved Hide resolved
src/contracts/Repository/ContentService.php Outdated Show resolved Hide resolved
src/contracts/Repository/ContentService.php Outdated Show resolved Hide resolved
src/contracts/Repository/ContentService.php Outdated Show resolved Hide resolved
src/contracts/Repository/ContentService.php Outdated Show resolved Hide resolved
src/contracts/Repository/ContentService.php Outdated Show resolved Hide resolved
src/contracts/Repository/ContentService.php Outdated Show resolved Hide resolved
src/contracts/Repository/ContentService.php Outdated Show resolved Hide resolved
src/contracts/Repository/ContentService.php Outdated Show resolved Hide resolved
src/contracts/Repository/ContentService.php Outdated Show resolved Hide resolved
src/contracts/Repository/ContentService.php Outdated Show resolved Hide resolved
@konradoboza konradoboza requested a review from a team June 28, 2024 09:53
@alongosz alongosz changed the title Improves ContentService PHPDoc [PHPDoc] Improved ContentService doc for API reference Jul 1, 2024
@alongosz
Copy link
Member

alongosz commented Jul 9, 2024

@adriendupuis this one needs rebase. Are all prior review remarks resolved and is it ready for another round of review?

Copy link

sonarcloud bot commented Jul 11, 2024

@adriendupuis adriendupuis marked this pull request as draft September 13, 2024 14:03
Copy link
Contributor

@konradoboza konradoboza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As long as https://github.com/ibexa/core/pull/379/files#r1828007119 and similar are applied.

src/contracts/Repository/ContentService.php Outdated Show resolved Hide resolved
@adriendupuis adriendupuis marked this pull request as ready for review November 5, 2024 08:29
Co-authored-by: Konrad Oboza <konrad.oboza@ibexa.co>
Copy link

sonarcloud bot commented Nov 5, 2024

@alongosz alongosz merged commit 9e313d2 into 4.6 Nov 5, 2024
26 checks passed
@alongosz alongosz deleted the improved_contentservice_phpdoc branch November 5, 2024 14:38
@adriendupuis adriendupuis mentioned this pull request Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants