Improved more PHPDoc comments

hamstar / Wikimate

A MediaWiki API wrapper for PHP based wikibots that [shouldn't] be confusing to use

MIT License

57 stars 24 forks source link

Improved more PHPDoc comments #150

Closed Xymph closed 1 year ago

Xymph commented 1 year ago

This resolves inline @see tags not getting linked in PHPDoc blocks, and various styling issues where the summary line wasn't properly separated from the description section. This makes every (I hope) docblock look good in phpDocumentor. Also includes grammar improvements.

Hmm, should the two "improve" PRs be in the Changed section of the changelog, instead?

waldyrious commented 1 year ago

Hmm, should the two "improve" PRs be in the Changed section of the changelog, instead?

Nah, they do fix (documentation) issues — they're not particularly serious, as they don't affect the behavior of the software itself, but they were corrections nevertheless. I'd say we keep them in the "Fixed" section.