Changeset 6573 for trunk/src/includes/common/formatting.php

Timestamp:

06/16/2017 09:20:52 PM (7 years ago)

Author:

johnjamesjacoby

Message:

Documentation: Remove all @uses usages.

Per the WordPress inline documentation standards:

the @uses tag is not recommended to be used to indicate a used-by relationship, as this information can be derived through other means. These tags also are very likely to become out-of-date as our functions change over time.

File:

• trunk/src/includes/common/formatting.php (modified) (8 diffs)

trunk/src/includes/common/formatting.php

@@ -108 +108 @@
  *
  * @param string $content Topic and reply content
- * @return string Partially encodedd content
+ * @return string Partially encoded content
  */
 function bbp_code_trick( $content = '' ) {
@@ -125 +125 @@
  *
  * @param string $content Topic and reply content
- * @return string Partially encodedd content
+ * @return string Partially encoded content
  */
 function bbp_code_trick_reverse( $content = '' ) {
@@ -149 +149 @@
  *
  * @param string $content Topic and reply content
- * @return string Partially encodedd content
+ * @return string Partially encoded content
  */
 function bbp_encode_bad( $content = '' ) {
@@ -540 +540 @@
  * @param string $number Number to format
  * @param string $decimals Optional. Display decimals
- * @uses apply_filters() Calls 'bbp_number_format' with the formatted values,
- *                        number and display decimals bool
+ *
  * @return string Formatted string
  */
@@ -562 +561 @@
  * @param string $number Number to format
  * @param string $decimals Optional. Display decimals
- * @uses apply_filters() Calls 'bbp_number_format' with the formatted values,
- *                        number and display decimals bool
+ *
  * @return string Formatted string
  */
@@ -588 +586 @@
  *                             format
  * @param bool $translate Optional. Default is false. Whether to translate the
- *                                   result
- * @uses mysql2date() To convert the format
- * @uses apply_filters() Calls 'bbp_convert_date' with the time, date format
- *                        and translate bool
+ *
  * @return string Returns timestamp
  */
@@ -610 +605 @@
  *                            difference ends. False for current time.
  * @param int $gmt Optional. Whether to use GMT timezone. Default is false.
- * @uses bbp_get_time_since() To get the formatted time
  */
 function bbp_time_since( $older_date, $newer_date = false, $gmt = false ) {
@@ -624 +618 @@
      *                            difference ends. False for current time.
      * @param int $gmt Optional. Whether to use GMT timezone. Default is false.
-     * @uses current_time() To get the current time in mysql format
-     * @uses human_time_diff() To get the time differene in since format
-     * @uses apply_filters() Calls 'bbp_get_time_since' with the time
-     *                        difference and time
+     *
      * @return string Formatted time
      */