Skip to content

fix(OC): Use @inheritDoc for OCP implementations - #47798

Draft
provokateurin wants to merge 3 commits into
masterfrom
fix/oc/inheritdoc
Draft

fix(OC): Use @inheritDoc for OCP implementations#47798
provokateurin wants to merge 3 commits into
masterfrom
fix/oc/inheritdoc

Conversation

@provokateurin

@provokateurinprovokateurin commented Sep 6, 2024

Copy link
Copy Markdown
Member

Summary

Ensures interface and implementation align. A step towards tightening OCP types.

TODO:

  • Check class docs Not possible because sometimes class docs need special annotations like @psalm-import-type or @template-implements
  • Fix resolving doctrine and psr classes
  • Fix bugs found by psalm

Checklist

@provokateurinprovokateurin changed the title wip: Remove unresolvable classesfix(OC): Use @inheritdoc for OCP implementationsSep 6, 2024
@provokateurinprovokateurin added 1. to develop Accepted and waiting to be taken care of technical debt 🧱 🤔🚀 labels Sep 6, 2024
@provokateurinprovokateurin added this to the Nextcloud 31 milestone Sep 6, 2024
@provokateurinprovokateurin changed the title fix(OC): Use @inheritdoc for OCP implementationsfix(OC): Use @inheritDoc for OCP implementationsSep 6, 2024
@provokateurinprovokateurin added 2. developing Work in progress and removed 1. to develop Accepted and waiting to be taken care of labels Sep 6, 2024
Signed-off-by: provokateurin <kate@provokateurin.de>
Signed-off-by: provokateurin <kate@provokateurin.de>
Signed-off-by: provokateurin <kate@provokateurin.de>

/**
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-only

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
* SPDX-License-Identifier: AGPL-3.0-only
* SPDX-License-Identifier: AGPL-3.0-or-later

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

The script will be removed from the PR anyway. When it is fixed once it is enforced by psalm so the script will never be needed again as everyone has to set the correct doc blocks in their PRs already.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sorry 🙈

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

No worries, I never said what is going to happen with this PR.
I plan to fix the issues that were found in separate PRs and once that is done we can merge the PR.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2. developingWork in progresstechnical debt🧱 🤔🚀

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@provokateurin@kesselb@joshtrichards@susnux@blizzz@skjnldsv@nextcloud-bot