AyeCode / invoicing

includes/wpinv-template-functions.php

Doc Comments +10 added lines

@@ -136,6 +136,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 );
@@ -168,6 +171,10 @@ 
     return apply_filters( 'wpinv_locate_template', $template, $template_name, $template_path );
 }
 
+/**
+ * @param string $slug
+ * @param boolean $name
+ */
 function wpinv_get_template_part( $slug, $name = null, $load = true ) {
 	do_action( 'get_template_part_' . $slug, $slug, $name );
 
@@ -867,6 +874,9 @@ 
     return apply_filters( 'wpinv_get_watermark', $output, $id );
 }
 
+/**
+ * @param integer $id
+ */
 function wpinv_get_watermark( $id ) {
     if ( !$id > 0 ) {
         return NULL;

includes/wpinv-user-functions.php

Doc Comments +3 added lines

@@ -161,6 +161,9 @@
     wp_redirect( $redirect_to );
 }
 
+/**
+ * @param integer $user_id
+ */
 function wpinv_login_user( $user_id ) {
     if ( is_user_logged_in() ) {
         return true;

includes/wpinv-helper-functions.php

Doc Comments +25 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'] );
@@ -110,6 +113,9 @@ 
     return $status;
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_currency() {
     $currency = wpinv_get_option( 'currency', 'USD' );
     
@@ -180,6 +186,9 @@ 
     return apply_filters( 'wpinv_currency_symbol', $currency_symbol, $currency );
 }
 
+/**
+ * @return string
+ */
 function wpinv_currency_position() {
     $position = wpinv_get_option( 'currency_position', 'left' );
     
@@ -198,6 +207,9 @@ 
     return apply_filters( 'wpinv_decimal_separator', $decimal_sep );
 }
 
+/**
+ * @return integer
+ */
 function wpinv_decimals() {
     $decimals = apply_filters( 'wpinv_decimals', wpinv_get_option( 'decimals', 2 ) );
     
@@ -308,6 +320,9 @@ 
     return $price;
 }
 
+/**
+ * @return string
+ */
 function wpinv_format_amount( $amount, $decimals = NULL, $calculate = false ) {
     $thousands_sep = wpinv_thousands_separator();
     $decimal_sep   = wpinv_decimal_separator();
@@ -357,6 +372,9 @@ 
     return apply_filters( 'wpinv_sanitize_key', $key, $raw_key );
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_file_extension( $str ) {
     $parts = explode( '.', $str );
     return end( $parts );
@@ -561,6 +579,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 );
@@ -569,6 +590,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 );
@@ -646,7 +670,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' ) ) {