Add config docblocks

Author: MGatner

examples/Visits.php

@@ -1,4 +1,6 @@
-<?php namespace Config;
+<?php
+
+namespace Config;
 
 /***
 *
@@ -13,21 +15,42 @@
 *
 ***/
 
-use CodeIgniter\Config\BaseConfig;
+use Tatter\Visits\Config\Visits as BaseConfig;
 
-class Visits extends \Tatter\Visits\Config\Visits
+class Visits extends BaseConfig
 {
-	// metric for tracking a unique visitor, one of: ip_address, session_id, user_id
-	// NOTE: using user_id will count empty $userSource values as unique visits
-	public $trackingMethod  = "ip_address";
-	
-	// the session variable to check for a logged-in user ID
-	public $userSource = 'logged_in';
-	
-	// how many minutes before a visit counts as new instead of incrementing a previous view count
-	// set to zero to record each visit as its own page view (not recommended)
-	public $resetMinutes = 60;
-	
-	// Whether to ignore AJAX requests when recording
-	public $ignoreAjax = true;
+    /**
+     * Metric for tracking a unique visitor
+     *
+     * @var 'ip_address'|'session_id'|'user_id'
+     */
+    public $trackingMethod = 'ip_address';
+
+    /**
+     * Session variable to check for a logged-in user ID
+     *
+     * @deprecated Next version will rely on codeigniter4/authentication-implementation
+     *
+     * @var string
+     */
+    public $userSource = 'logged_in';
+
+    /**
+     * Number of minutes before a visit counts as new
+     * instead of incrementing a previous view count.
+     * Set to zero to record each page view as unique (not recommended).
+     *
+     * @var int
+     */
+    public $resetMinutes = 60;
+
+    /**
+     * Whether to ignore AJAX requests when recording.
+     * See framework User Guide for caveats.
+     *
+     * @see https://www.codeigniter.com/user_guide/general/ajax.html
+     *
+     * @var bool
+     */
+    public $ignoreAjax = true;
 }

src/Config/Visits.php

@@ -6,17 +6,38 @@
 
 class Visits extends BaseConfig
 {
-    // metric for tracking a unique visitor
-    // one of: ip_address, session_id, user_id
+    /**
+     * Metric for tracking a unique visitor
+     *
+     * @var 'ip_address'|'session_id'|'user_id'
+     */
     public $trackingMethod = 'ip_address';
 
-    // the session variable to check for a logged-in user ID
+    /**
+     * Session variable to check for a logged-in user ID
+     *
+     * @deprecated Next version will rely on codeigniter4/authentication-implementation
+     *
+     * @var string
+     */
     public $userSource = 'logged_in';
 
-    // how many minutes before a visit counts as new instead of incrementing a previous view count
-    // set to zero to record each page view as unique (not recommended)
+    /**
+     * Number of minutes before a visit counts as new
+     * instead of incrementing a previous view count.
+     * Set to zero to record each page view as unique (not recommended).
+     *
+     * @var int
+     */
     public $resetMinutes = 60;
 
-    // Whether to ignore AJAX requests when recording
+    /**
+     * Whether to ignore AJAX requests when recording.
+     * See framework User Guide for caveats.
+     *
+     * @see https://www.codeigniter.com/user_guide/general/ajax.html
+     *
+     * @var bool
+     */
     public $ignoreAjax = true;
 }