YOURLS / YOURLS

includes/functions-infos.php

Doc Comments +2 added lines

@@ -310,6 +310,8 @@
 /**
  * Return javascript code that will display the Google Chart
  *
+ * @param string $graph_type
+ * @param string $data
  */
 function yourls_google_viz_code( $graph_type, $data, $options, $id ) {
 	$function_name = 'yourls_graph' . $id;

includes/functions-plugins.php

Doc Comments +6 added lines, -3 removed lines

@@ -78,7 +78,7 @@ 
  *
  * @global array $yourls_filters storage for all of the filters
  * @param string $hook hook to which the function is attached
- * @param string|array $function used for creating unique id
+ * @param callable $function used for creating unique id
  * @param int|bool $priority used in counting how many hooks were applied.  If === false and $function is an object reference, we return the unique id only if it already has one, false otherwise.
  * @return string unique ID for usage as array key
  */
@@ -458,7 +458,7 @@ 
  * Activate a plugin
  *
  * @param string $plugin Plugin filename (full or relative to plugins directory)
- * @return mixed string if error or true if success
+ * @return string|boolean string if error or true if success
  */
 function yourls_activate_plugin( $plugin ) {
 	// validate file
@@ -497,7 +497,7 @@ 
  * Deactivate a plugin
  *
  * @param string $plugin Plugin filename (full relative to plugins directory)
- * @return mixed string if error or true if success
+ * @return string|boolean string if error or true if success
  */
 function yourls_deactivate_plugin( $plugin ) {
 	$plugin = yourls_plugin_basename( $plugin );
@@ -561,6 +561,9 @@ 
 
 /**
  * Register a plugin administration page
+ * @param string $slug
+ * @param string $title
+ * @param string $function
  */
 function yourls_register_plugin_page( $slug, $title, $function ) {
 	global $ydb;

includes/functions-l10n.php

Doc Comments +4 added lines, -5 removed lines

@@ -117,7 +117,6 @@ 
  * @since 1.6
  *
  * @param string $pattern Text to translate
- * @param string $arg1, $arg2... Optional: sprintf tokens, and translation domain
  * @return string Translated text
  */
 function yourls_s( $pattern ) {
@@ -159,7 +158,6 @@ 
  * @since 1.6
  *
  * @param string $pattern Text to translate
- * @param string $arg1, $arg2... Optional: sprintf tokens, and translation domain
  * @return string Translated text
  */
 function yourls_se( $pattern ) {
@@ -347,6 +345,7 @@ 
  * @see yourls_n()
  * @see yourls_x()
  *
+ * @param integer $number
  */
 function yourls_nx($single, $plural, $number, $context, $domain = 'default') {
 	$translations = yourls_get_translations_for_domain( $domain );
@@ -503,7 +502,7 @@ 
  * translated (.mo) file is named based on the locale.
  *
  * @since 1.6
- * @return bool True on success, false on failure
+ * @return boolean|null True on success, false on failure
  */
 function yourls_load_default_textdomain() {
 	$yourls_locale = yourls_get_locale();
@@ -683,7 +682,7 @@ 
  * @since 1.6
  *
  * @param string $type Either 'mysql' or 'timestamp'.
- * @param int|bool $gmt Optional. Whether to use GMT timezone. Default is false.
+ * @param integer $gmt Optional. Whether to use GMT timezone. Default is false.
  * @return int|string String if $type is 'gmt', int if $type is 'timestamp'.
  */
 function yourls_current_time( $type, $gmt = 0 ) {
@@ -1040,7 +1039,7 @@ 
  *
  * @param string $domain Unique identifier (the "domain") for retrieving translated strings
  * @param string $path Full path to directory containing MO files.
- * @return mixed Returns nothing if locale undefined, otherwise return bool: true on success, false on failure
+ * @return boolean|null Returns nothing if locale undefined, otherwise return bool: true on success, false on failure
  */
 function yourls_load_custom_textdomain( $domain, $path ) {
 	$locale = yourls_apply_filter( 'load_custom_textdomain', yourls_get_locale(), $domain );

includes/functions-install.php

Doc Comments +1 added lines, -1 removed lines

@@ -146,7 +146,7 @@
  *
  * @param string $filename
  * @param string $marker
- * @param array  $insertion
+ * @param string[]  $insertion
  * @return bool True on write success, false on failure.
  */
 function yourls_insert_with_markers( $filename, $marker, $insertion ) {

includes/functions-formatting.php

Doc Comments +3 added lines, -1 removed lines

@@ -129,6 +129,8 @@ 
  *
  * Stolen from WP's _deep_replace
  *
+ * @param string[] $search
+ * @param string $subject
  */
 function yourls_deep_replace( $search, $subject ){
 	$found = true;
@@ -309,7 +311,7 @@ 
  * @since 1.6
  *
  * @param string $string The text which is to be encoded.
- * @param mixed $quote_style Optional. Converts double quotes if set to ENT_COMPAT, both single and double if set to ENT_QUOTES or none if set to ENT_NOQUOTES. Also compatible with old values; converting single quotes if set to 'single', double if set to 'double' or both if otherwise set. Default is ENT_NOQUOTES.
+ * @param integer $quote_style Optional. Converts double quotes if set to ENT_COMPAT, both single and double if set to ENT_QUOTES or none if set to ENT_NOQUOTES. Also compatible with old values; converting single quotes if set to 'single', double if set to 'double' or both if otherwise set. Default is ENT_NOQUOTES.
  * @param boolean $double_encode Optional. Whether to encode existing html entities. Default is false.
  * @return string The encoded text with HTML entities.
  */

includes/functions-html.php

Doc Comments +5 added lines

@@ -505,6 +505,9 @@ 
 /**
  * Return an "Add" row for the main table
  *
+ * @param string $url
+ * @param integer $clicks
+ * @param integer $timestamp
  * @return string HTML of the edit row
  */
 function yourls_table_add_row( $keyword, $url, $title = '', $ip, $clicks, $timestamp ) {
@@ -823,6 +826,7 @@ 
 /**
  * Wrapper function to display admin notices
  *
+ * @param string $message
  */
 function yourls_add_notice( $message, $style = 'notice' ) {
 	// Escape single quotes in $message to avoid breaking the anonymous function
@@ -833,6 +837,7 @@ 
 /**
  * Return a formatted notice
  *
+ * @param string $message
  */
 function yourls_notice_box( $message, $style = 'notice' ) {
 	return <<<HTML

includes/functions.php

Doc Comments +11 added lines, -5 removed lines

@@ -37,6 +37,7 @@ 
 /**
  * Is a URL a short URL? Accept either 'http://sho.rt/abc' or 'abc'
  *
+ * @param string $shorturl
  */
 function yourls_is_shorturl( $shorturl ) {
 	// TODO: make sure this function evolves with the feature set.
@@ -140,6 +141,7 @@ 
 /**
  * SQL query to insert a new link in the DB. Returns boolean for success or failure of the inserting
  *
+ * @param string $url
  */
 function yourls_insert_link_in_db( $url, $keyword, $title = '' ) {
 	global $ydb;
@@ -380,6 +382,7 @@ 
 /**
  * Update a title link (no checks for duplicates etc..)
  *
+ * @param string $title
  */
 function yourls_edit_link_title( $keyword, $title ) {
 	// Allow plugins to short-circuit the whole function
@@ -482,6 +485,7 @@ 
 /**
  * Return (string) selected information associated with a keyword. Optional $notfound = string default message if nothing found
  *
+ * @param string $field
  */
 function yourls_get_keyword_info( $keyword, $field, $notfound = false ) {
 
@@ -768,6 +772,7 @@ 
 /**
  * Return a HTTP status code
  *
+ * @param integer $code
  */
 function yourls_get_HTTP_status( $code ) {
 	$code = intval( $code );
@@ -882,7 +887,7 @@ 
  *
  * @since 1.4
  * @param string $ip IP or, if empty string, will be current user IP
- * @param string $defaut Default string to return if IP doesn't resolve to a country (malformed, private IP...)
+ * @param string $default Default string to return if IP doesn't resolve to a country (malformed, private IP...)
  * @return string 2 letter country code (eg 'US') or $default
  */
 function yourls_geo_ip_to_countrycode( $ip = '', $default = '' ) {
@@ -1508,9 +1513,6 @@ 
  * The result of this function call is a URL : it should be escaped before being printed as HTML
  *
  * @since 1.5
- * @param string|array $param1 Either newkey or an associative_array.
- * @param string       $param2 Either newvalue or oldquery or URI.
- * @param string       $param3 Optional. Old query or URI.
  * @return string New URL query string.
  */
 function yourls_add_query_arg() {
@@ -1631,6 +1633,7 @@ 
 /**
  * Create a nonce field for inclusion into a form
  *
+ * @param string $action
  */
 function yourls_nonce_field( $action, $name = 'nonce', $user = false, $echo = true ) {
 	$field = '<input type="hidden" id="'.$name.'" name="'.$name.'" value="'.yourls_create_nonce( $action, $user ).'" />';
@@ -1642,6 +1645,7 @@ 
 /**
  * Add a nonce to a URL. If URL omitted, adds nonce to current URL
  *
+ * @param string $action
  */
 function yourls_nonce_url( $action, $url = false, $name = 'nonce', $user = false ) {
 	$nonce = yourls_create_nonce( $action, $user );
@@ -1654,6 +1658,7 @@ 
  * Returns true if valid, dies otherwise (yourls_die() or die($return) if defined)
  * if $nonce is false or unspecified, it will use $_REQUEST['nonce']
  *
+ * @param string $action
  */
 function yourls_verify_nonce( $action, $nonce = false, $user = false, $return = '' ) {
 	// get user
@@ -1956,6 +1961,7 @@ 
 /**
  * Change protocol to match current scheme used (http or https)
  *
+ * @param string $url
  */
 function yourls_match_current_protocol( $url, $normal = 'http://', $ssl = 'https://' ) {
 	if( yourls_is_ssl() )
@@ -2083,7 +2089,7 @@ 
 /**
  * Return current admin page, or null if not an admin page
  *
- * @return mixed string if admin page, null if not an admin page
+ * @return string|null string if admin page, null if not an admin page
  * @since 1.6
  */
 function yourls_current_admin_page() {

includes/Config/Config.php

Doc Comments +1 added lines

@@ -50,6 +50,7 @@
     /**
      * @since  1.7.3
      * @param  string  path to YOURLS root directory
+     * @param string $root
      * @return void
      */
     public function set_root($root) {