docs: update docblocks

src/includes/class-footnotes-config.php

@@ -2,11 +2,11 @@
 /**
  * Includes the Plugin Constants class to load all Plugin constant vars like Plugin name, etc.
  *
- * @filesource
- * @package footnotes
  * @since 1.5.0
- *
  * @since 2.0.4  add Public Plugin name for dashboard heading
+ *
+ * @package footnotes
+ * @sunpackage footnotes/includes
  */
 
 /**

src/includes/class-footnotes-convert.php

@@ -2,11 +2,11 @@
 /**
  * Includes the Convert Class.
  *
- * @filesource
- * @package footnotes
  * @since 1.5.0
- *
  * @since 2.2.0  add lowercase Roman
+ *
+ * @package footnotes
+ * @sunpackage footnotes/includes
  */
 
 /**

src/includes/class-footnotes-settings.php

@@ -2,15 +2,16 @@
 /**
  * Includes the Settings class to handle all Plugin settings.
  *
- * @filesource
- * @package footnotes
- * @since 1.5.0
- *
  * The constants are ordered by ascending version so their docblocks can replace most of this list.
+ *
+ * @since 1.5.0
  * @since 2.0.0  Update: **symbol for backlinks** removed; hyperlink moved to the reference number.
  * @since 2.0.4  Update: Restore arrow settings to customize or disable the now prepended arrow symbol, thanks to @mmallett issue report.
  * @since 2.0.7  BUGFIX: Hooks: Default-disable 'the_post', thanks to @spaceling @markcheret @nyamachi @whichgodsaves @spiralofhope2 @mmallett @andreasra @widecast @ymorin007 @tashi1es bug reports.
  * @since 2.1.3  Bugfix: Hooks: disable the_excerpt hook by default to fix issues, thanks to @nikelaos bug report.
+ *
+ * @package footnotes
+ * @subpackage footnotes/includes
  */
 
 require_once dirname( __FILE__ ) . '/class-footnotes-convert.php';

src/includes/class-footnotes-template.php

@@ -2,12 +2,12 @@
 /**
  * Includes the Template Engine to load and handle all Template files of the Plugin.
  *
- * @filesource
- * @package footnotes
  * @since 1.5.0
- *
  * @since 2.2.6  Adding: Templates: support for custom templates in sibling folder, thanks to @misfist issue report.
  * @since 2.5.0  Adding: Templates: Enable template location stack, thanks to @misfist issue report and code contribution.
+ *
+ * @package footnotes
+ * @subpackage footnotes/includes
  */
 
 /**

src/includes/class-footnotes.php

@@ -82,10 +82,14 @@ class Footnotes {
 	 *
 	 * Include the following files that make up the plugin:
 	 *
-	 * - Footnotes_Loader. Orchestrates the hooks of the plugin.
-	 * - Footnotes_i18n. Defines internationalization functionality.
-	 * - Footnotes_Admin. Defines all hooks for the admin area.
-	 * - Footnotes_Public. Defines all hooks for the public side of the site.
+	 * - `Footnotes_Loader`. Orchestrates the hooks of the plugin.
+	 * - `Footnotes_i18n`. Defines internationalization functionality.
+	 * - `Footnotes_Config`. Defines plugin details.
+	 * - `Footnotes_Convert`. Provides conversion methods.
+	 * - `Footnotes_Settings`. Defines customisable plugin settings.
+	 * - `Footnotes_Template`. Handles template rendering.
+	 * - `Footnotes_Admin`. Defines all hooks for the admin area.
+	 * - `Footnotes_Public`. Defines all hooks for the public side of the site.
 	 *
 	 * Create an instance of the loader which will be used to register the hooks
 	 * with WordPress.
@@ -106,7 +110,10 @@ class Footnotes {
 		 * of the plugin.
 		 */
 		require_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-footnotes-i18n.php';
-		// TODO: neaten up and document once placements and names are settled.
+		
+		/**
+		 * The various utility classes.
+		 */
 		require_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-footnotes-config.php';
 		require_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-footnotes-convert.php';
 		require_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-footnotes-settings.php';