Add missing inline docs for esc_attr_x() and esc_html_x()

[ocean90]

See trunk/wp-includes/l10n.php:22346#L208​.

#9650

[fjarrett]

OK I've added inline docs to both functions.

I also spotted an inconsistency with the first argument being named $single which does not match what is used in similar functions nor does it even match what is in the Codex.

​http://codex.wordpress.org/Function_Reference/esc_attr_x
​http://codex.wordpress.org/Function_Reference/esc_html_x

So in this patch, I've updated the first argument in both functions to correctly use the var name $text.

[ocean90]

Thanks fjarett.

The @since tag should reference 2.8.0 for esc_attr_x ([11103]/[11204]) and 2.9.0 for esc_html_x ([12231]).

[fjarrett]

Good catch, thanks! Updated @since.

[nacin]

In 24825:

Inline documentation for esc_attr_x() and esc_html_x(). props fjarrett, fixes #24212.

[dimadin]

There is a mistake in this documentation since it states that these functions display string while they just return it.

I've changed first sentence based on existing documentation of i18n escaping functions.

[ericlewis]

In attachment:24212.4.diff​:

• Changed the description for any text domain variable passed around functions from "Unique identifier for retrieving translated strings." to just "Text domain." as well as all mentions of "domain" to "text domain".
• Simplified @dimadin's short descriptions of esc_attr_x and esc_html_x - we don't need to know the string won't be translated if there is no translation or a domain is not supplied, that's implied behavior and not documented as such in the rest of the translation functions.

[DrewAPicture]

Replying to ericlewis:

In attachment:24212.4.diff​:

• Changed the description for any text domain variable passed around functions from "Unique identifier for retrieving translated strings." to just "Text domain." as well as all mentions of "domain" to "text domain".
• Simplified @dimadin's short descriptions of esc_attr_x and esc_html_x - we don't need to know the string won't be translated if there is no translation or a domain is not supplied, that's implied behavior and not documented as such in the rest of the translation functions.

This ticket is specifically about esc_attr_x() and esc_html_x(). I'd suggest submitting your other changes to the l10n.php ticket closed yesterday: #16750

[ericlewis]

Replying to DrewAPicture:

This ticket is specifically about esc_attr_x() and esc_html_x(). I'd suggest submitting your other changes to the l10n.php ticket closed yesterday: #16750

Sure, pardon me.

[ericlewis]

attachment:24212.5.diff​ removes surplus documentation editing that will be moved to #16750

[DrewAPicture]

In 25493:

Clarify phpdoc descriptions for esc_attr_x() and esc_html_x().

props ericlewis. Fixes #24212.