Added Automatic PHPDoc generation

lotgd / core

Core functionality for Legend of the Green Dragon, a text-based RPG game.

GNU Affero General Public License v3.0

152 stars 15 forks source link

Added Automatic PHPDoc generation #169

Closed GaeaKat closed 3 years ago

GaeaKat commented 3 years ago

the PR should when a push to Master occurs, run phpdocumentor on the src/ directory, putting the output in doc/ it will use phpdoc.dist.xml for settings.

Vassyli commented 3 years ago

Interesting idea!

A few questions:

Is there a specific reason why you are using the action from your own cloned repository instead of the original one?
The action states it supports doc generation "up to pHP version 7.0", but I've switched to 8.0 meanwhile.
Does PHPDoc recognize typehints? I'm not in favour of keeping typehints and Docblocks in sync - eventually, I want to get rid typehints in doc blocks.

GaeaKat commented 3 years ago

No problem. I use an action from my own repo to add in PHP-8 compatibility as as you point out, the original is only PHP 7.

Regarding the typehints, I am unsure, And will test shortly

GaeaKat commented 3 years ago

Tested by adding the following function to Action as a test with no Docblock

public function i_test_things(string $puppy,int $kitty,ActionGroup $pop) {

    }

it outputs this as expected.

Screenshot 2021-09-05 at 21 59 05

Vassyli commented 3 years ago

Thank you a lot.

Vassyli commented 3 years ago

Contributes to #33

Vassyli commented 3 years ago

This seems to fail as the master branch is protected. Any ideas?