]> Kevux Git Server - koopa/commitdiff
Cleanup: add missing class object comments for user path classes
authorKevin Day <thekevinday@gmail.com>
Thu, 31 Aug 2017 07:38:03 +0000 (02:38 -0500)
committerKevin Day <thekevinday@gmail.com>
Thu, 31 Aug 2017 07:38:03 +0000 (02:38 -0500)
common/standard/paths/u/user_create.php
common/standard/paths/u/user_delete.php
common/standard/paths/u/user_edit.php
common/standard/paths/u/user_lock.php
common/standard/paths/u/user_pdf.php
common/standard/paths/u/user_print.php
common/standard/paths/u/user_ps.php
common/standard/paths/u/user_settings.php
common/standard/paths/u/user_unlock.php
common/standard/paths/u/user_view.php

index 0142c19dd6704bbcfe24d437d25df5bbd6ecb1c0..faffa0922ad3b79c8f4e258a9b83fcd284b7dba9 100644 (file)
@@ -12,6 +12,11 @@ require_once('common/standard/classes/standard_path.php');
 
 require_once('common/theme/classes/theme_html.php');
 
+/**
+ * Provides a path handler for user creation.
+ *
+ * This listens on: /u/create
+ */
 class c_standard_path_user_create extends c_standard_path {
   protected const PATH_SELF = 'u/create';
 
index a3c89f22ca9f1072cdd58d164bbd0f0b5a3de80b..33bfb90f16c4c96bcbe583a4ba8e404a742a1c88 100644 (file)
@@ -12,6 +12,11 @@ require_once('common/standard/classes/standard_path.php');
 
 require_once('common/theme/classes/theme_html.php');
 
+/**
+ * Provides a path handler for user deletion.
+ *
+ * This listens on: /u/delete
+ */
 class c_standard_path_user_delete extends c_standard_path {
   protected const PATH_SELF = 'u/delete';
 
index 9a755f42fe5180ecdd79dfe389a2c8dcede6a2ef..fe423829b78795a23a09ef33dc9ff1855b4d292f 100644 (file)
@@ -12,6 +12,11 @@ require_once('common/standard/classes/standard_path.php');
 
 require_once('common/theme/classes/theme_html.php');
 
+/**
+ * Provides a path handler for user editing.
+ *
+ * This listens on: /u/edit
+ */
 class c_standard_path_user_edit extends c_standard_path {
   protected const PATH_SELF = 'u/edit';
 
index b4186971d23698beaa34c52628f94a928a61882b..b6c9613c90b81640737e85f65c2e4c975cb20579 100644 (file)
@@ -12,6 +12,11 @@ require_once('common/standard/classes/standard_path.php');
 
 require_once('common/theme/classes/theme_html.php');
 
+/**
+ * Provides a path handler for user locking.
+ *
+ * This listens on: /u/lock
+ */
 class c_standard_path_user_lock extends c_standard_path {
   protected const PATH_SELF = 'u/lock';
 
index b191fe847e14373ec506150af8cd3e491b9a4333..aaa097b6fef429a429ac85d44d00761bfa4c5fb9 100644 (file)
@@ -12,6 +12,11 @@ require_once('common/standard/classes/standard_path.php');
 
 require_once('common/theme/classes/theme_html.php');
 
+/**
+ * Provides a path handler for user in pdf format.
+ *
+ * This listens on: /u/pdf
+ */
 class c_standard_path_user_pdf extends c_standard_path {
   protected const PATH_SELF = 'u/pdf';
 
index d3105533b3a5c04c2fee64c264f12ff20b17785b..85edeecbf3313480bdf3b3b0a7421f77f31f12f3 100644 (file)
@@ -12,6 +12,11 @@ require_once('common/standard/classes/standard_path.php');
 
 require_once('common/theme/classes/theme_html.php');
 
+/**
+ * Provides a path handler for user print format (printer-friendly).
+ *
+ * This listens on: /u/print
+ */
 class c_standard_path_user_print extends c_standard_path {
   protected const PATH_SELF = 'u/print';
 
index eda53233a74d0f94c9fcbfbd716889bfcb34ba80..9e8087509346202adc9cd77ba39afbaad9d224a2 100644 (file)
@@ -12,6 +12,11 @@ require_once('common/standard/classes/standard_path.php');
 
 require_once('common/theme/classes/theme_html.php');
 
+/**
+ * Provides a path handler for user postcript (postcript format).
+ *
+ * This listens on: /u/ps
+ */
 class c_standard_path_user_ps extends c_standard_path {
   protected const PATH_SELF = 'u/ps';
 
index 4612e2a7d836af00f2bfe7a9c2d4a40474abaa5c..2d2dc058b8cbadb41c3661f4e63522315a287003 100644 (file)
@@ -12,6 +12,11 @@ require_once('common/standard/classes/standard_path.php');
 
 require_once('common/theme/classes/theme_html.php');
 
+/**
+ * Provides a path handler for user settings.
+ *
+ * This listens on: /u/settings
+ */
 class c_standard_path_user_settings extends c_standard_path {
   protected const PATH_SELF = 'u/settings';
 
index 1a93e04432c5b56f204a0a0eb808df1683edca7c..0e560624cbb738c4df7025ed0a2846eecf1dc156 100644 (file)
@@ -12,6 +12,11 @@ require_once('common/standard/classes/standard_path.php');
 
 require_once('common/theme/classes/theme_html.php');
 
+/**
+ * Provides a path handler for user unlocking.
+ *
+ * This listens on: /u/unlock
+ */
 class c_standard_path_user_unlock extends c_standard_path {
   protected const PATH_SELF = 'u/unlock';
 
index 936179d7fc38e48c4b9834bd93ca498ba09d4ec7..5e8d8bce5783130c67e2d0c9b8ab04106e239851 100644 (file)
@@ -13,6 +13,11 @@ require_once('common/standard/classes/standard_path.php');
 
 require_once('common/theme/classes/theme_html.php');
 
+/**
+ * Provides a path handler for user viewing (normal view).
+ *
+ * This listens on: /u/view
+ */
 class c_standard_path_user_view extends c_standard_path {
   protected const PATH_SELF = 'u/view';