Add some PHPDoc comments for ease of programming #87

Merged

lpoujol merged 6 commits from mtrossevin/evoadmin-web:doc-comments into unstable

2024-04-22 16:58:40 +02:00

mtrossevin commented

2023-11-16 10:11:00 +01:00

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

c9768fef8b

Fix some of the docblocks

a691259ae6

Add some of the missing doc-comments

mtrossevin added 3 commits 2023-11-16 10:59:51 +01:00

10ceade38c

Add remaining missing PHPDoc comments (outside of lib/)

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.)

e66cca7e2e

Add missing PHPDoc

mtrossevin commented

2023-11-16 11:01:38 +01:00

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

c5a36f1f43 Merge branch 'unstable' into doc-comments

mtrossevin commented

2023-11-16 11:14:37 +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.