AyeCode / invoicing

includes/wpinv-helper-functions.php

Doc Comments +28 added lines, -1 removed lines

@@ -31,6 +31,9 @@ 
     return apply_filters( 'wpinv_get_ip', $ip );
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_user_agent() {
     if ( ! empty( $_SERVER['HTTP_USER_AGENT'] ) ) {
         $user_agent = sanitize_text_field( $_SERVER['HTTP_USER_AGENT'] );
@@ -41,6 +44,9 @@ 
     return apply_filters( 'wpinv_get_user_agent', $user_agent );
 }
 
+/**
+ * @param integer $decimals
+ */
 function wpinv_sanitize_amount( $amount, $decimals = NULL ) {
     $is_negative   = false;
     $thousands_sep = wpinv_thousands_separator();
@@ -79,6 +85,9 @@ 
 }
 add_filter( 'wpinv_sanitize_amount_decimals', 'wpinv_currency_decimal_filter', 10, 1 );
 
+/**
+ * @param integer $decimals
+ */
 function wpinv_round_amount( $amount, $decimals = NULL ) {
     if ( $decimals === NULL ) {
         $decimals = wpinv_decimals();
@@ -117,6 +126,9 @@ 
     return $status;
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_currency() {
     $currency = wpinv_get_option( 'currency', 'USD' );
     
@@ -187,6 +199,9 @@ 
     return apply_filters( 'wpinv_currency_symbol', $currency_symbol, $currency );
 }
 
+/**
+ * @return string
+ */
 function wpinv_currency_position() {
     $position = wpinv_get_option( 'currency_position', 'left' );
     
@@ -315,6 +330,9 @@ 
     return $price;
 }
 
+/**
+ * @return string
+ */
 function wpinv_format_amount( $amount, $decimals = NULL, $calculate = false ) {
     $thousands_sep = wpinv_thousands_separator();
     $decimal_sep   = wpinv_decimal_separator();
@@ -365,6 +383,9 @@ 
     return apply_filters( 'wpinv_sanitize_key', $key, $raw_key );
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_file_extension( $str ) {
     $parts = explode( '.', $str );
     return end( $parts );
@@ -569,6 +590,9 @@ 
     return strlen( $str );
 }
 
+/**
+ * @param string $str
+ */
 function wpinv_utf8_strtolower( $str, $encoding = 'UTF-8' ) {
     if ( function_exists( 'mb_strtolower' ) ) {
         return mb_strtolower( $str, $encoding );
@@ -577,6 +601,9 @@ 
     return strtolower( $str );
 }
 
+/**
+ * @param string $str
+ */
 function wpinv_utf8_strtoupper( $str, $encoding = 'UTF-8' ) {
     if ( function_exists( 'mb_strtoupper' ) ) {
         return mb_strtoupper( $str, $encoding );
@@ -654,7 +681,7 @@ 
  *
  * @param string $str The string being decoded.
  * @param string $encoding The encoding parameter is the character encoding. Default "UTF-8".
- * @return string The width of string.
+ * @return integer The width of string.
  */
 function wpinv_utf8_strwidth( $str, $encoding = 'UTF-8' ) {
     if ( function_exists( 'mb_strwidth' ) ) {

includes/wpinv-email-functions.php

Doc Comments +6 added lines

@@ -664,6 +664,9 @@ 
     return $sent;
 }
 
+/**
+ * @return string
+ */
 function wpinv_mail_get_from_address() {
     $from_address = apply_filters( 'wpinv_mail_from_address', wpinv_get_option( 'email_from' ) );
     return sanitize_email( $from_address );
@@ -1123,6 +1126,9 @@ 
 }
 add_filter( 'wpinv_settings_sections_emails', 'wpinv_settings_sections_emails', 10, 1 );
 
+/**
+ * @param string $email_type
+ */
 function wpinv_email_is_enabled( $email_type ) {
     $emails = wpinv_get_emails();
     $enabled = isset( $emails[$email_type] ) && wpinv_get_option( 'email_'. $email_type . '_active', 0 ) ? true : false;

includes/class-wpinv-shortcodes.php

Doc Comments +3 added lines

@@ -21,6 +21,9 @@
         add_shortcode( 'wpinv_messages', __CLASS__ . '::messages' );
     }
 
+    /**
+     * @param string[] $function
+     */
     public static function shortcode_wrapper(
         $function,
         $atts    = array(),

includes/wpinv-template-functions.php

Doc Comments +9 added lines

@@ -140,6 +140,9 @@ 
 	do_action( 'wpinv_after_template_part', $template_name, $template_path, $located, $args );
 }
 
+/**
+ * @param string $template_name
+ */
 function wpinv_get_template_html( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
 	ob_start();
 	wpinv_get_template( $template_name, $args, $template_path, $default_path );
@@ -172,6 +175,9 @@ 
     return apply_filters( 'wpinv_locate_template', $template, $template_name, $template_path );
 }
 
+/**
+ * @param string $slug
+ */
 function wpinv_get_template_part( $slug, $name = null, $load = true ) {
 	do_action( 'get_template_part_' . $slug, $slug, $name );
 
@@ -871,6 +877,9 @@ 
     return apply_filters( 'wpinv_get_watermark', $output, $id );
 }
 
+/**
+ * @param integer $id
+ */
 function wpinv_get_watermark( $id ) {
     if ( !$id > 0 ) {
         return NULL;