Add some PHPDoc comments for ease of programming #87

Open
mtrossevin wants to merge 6 commits from mtrossevin/evoadmin-web:doc-comments into unstable
Owner

This PR fix some existing PHPDoc comments and add as many as possible. This is mostly for ease of programming by enabling IDEs to better detect problems with types.

There is exactly 1 change in the code itself, but it shouldn't change anything as the return of is_superadmin() is already treated exclusively as a bool and not an int.

This PR fix some existing PHPDoc comments and add as many as possible. This is mostly for ease of programming by enabling IDEs to better detect problems with types. There is exactly 1 change in the code itself, but it shouldn't change anything as the return of `is_superadmin()` is already treated exclusively as a `bool` and not an `int`.
mtrossevin added 2 commits 2023-11-16 10:11:02 +01:00
mtrossevin added 3 commits 2023-11-16 10:59:51 +01:00
659575960d
fix(lib/bdd.php) Fix PHPDoc
@desc doesn't exists in PHPDoc causing VSCode to ignore the description
lines. (Also it is superfluous anyway.)
Author
Owner

There remains a few PHPDocs missing in evolibs/Form.php and lib/bdd.php but it can be done later.

There remains a few PHPDocs missing in `evolibs/Form.php` and `lib/bdd.php` but it can be done later.
mtrossevin changed title from WIP: Add some PHPDoc comments for ease of programming to Add some PHPDoc comments for ease of programming 2023-11-16 11:01:40 +01:00
mtrossevin requested review from lpoujol 2023-11-16 11:02:56 +01:00
mtrossevin requested review from whirigoyen 2023-11-16 11:02:56 +01:00
mtrossevin changed title from Add some PHPDoc comments for ease of programming to Add some PHPDoc comments for ease of programming 2023-11-16 11:05:14 +01:00
mtrossevin changed target branch from master to unstable 2023-11-16 11:05:14 +01:00
mtrossevin added 1 commit 2023-11-16 11:05:58 +01:00
Author
Owner

I am unsure on if there should be an entry added to CHANGELOG.md for this change (or where to put such an entry) as it isn't an user facing change nor a change in behaviour.

I am unsure on if there should be an entry added to `CHANGELOG.md` for this change (or where to put such an entry) as it isn't an user facing change nor a change in behaviour.
Owner

Works for me 👍

Works for me 👍
mtrossevin removed review request for whirigoyen 2023-11-17 11:07:42 +01:00
whirigoyen approved these changes 2023-11-17 11:17:03 +01:00
mtrossevin added the
Doc
label 2023-11-17 14:42:58 +01:00
This pull request can be merged automatically.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
You can also view command line instructions.

Step 1:

From your project repository, check out a new branch and test the changes.
git checkout -b mtrossevin-doc-comments unstable
git pull doc-comments

Step 2:

Merge the changes and update on Forgejo.
git checkout unstable
git merge --no-ff mtrossevin-doc-comments
git push origin unstable
Sign in to join this conversation.
No description provided.