PHPDoc comments and @return tags missing at many places

[subrataemfluence]

Function/methods and property declarations are missing PHPDoc comment and @return tags at many places of src/wp-includes/pomo/translations.php

Proposed patch added.

[subrataemfluence]

Proposed patch

[pento]

Reviewing 44424.diff​:

• $entries and $headers could do with descriptions.
• get_header() returns a header, not an element.
• translate_entry() returns an entry, not an element.
• select_plural_form() returns int, and the return needs a description.
• translate_plural() only returns a string. The params and return need a description.
• gettext_select_plural_form() returns the result of calling the callable that make_plural_form_function() returns. The callable that make_plural_form_function() returns will return an int.
• make_plural_form_function() returns a callable.
• All of the docblocks added to NOOP_Translations need descriptions.

[niravsherasiya7707]

@swissspidy Should I take ownership of the task to implement the improvements?

[swissspidy]

You can, but it's not a requirement. People reading through the comments here will see that you're working on it regardless :-)

Just remember to follow the ​PHP documentation standards

Trac ticket: https://core.trac.wordpress.org/ticket/44424

Description :

Add missing PHPDoc comments and @return tags in many places.

Changes:

Class Translations:
Manages translation entries and headers.
Methods for adding entries, setting headers, translating, and merging entries.

Class Gettext_Translations (extends Translations):
Extends Translations with gettext-specific functionality.
Handles plural forms and expressions for gettext translations.

Class NOOP_Translations:
Provides a placeholder class with the same interface as Translations but no actual translation operations.

[swissspidy]

In 57734:

I18N: Improve docs for pomo library classes.

Props subrataemfluence, pento, hrshahin.
Fixes #44424.

Fixed in https://core.trac.wordpress.org/changeset/57734