Cleanup: add missing class object comments for user path classes

diff --git a/common/standard/paths/u/user_create.php b/common/standard/paths/u/user_create.php
index 0142c19..faffa09 100644 (file)
--- a/common/standard/paths/u/user_create.php
+++ b/common/standard/paths/u/user_create.php
@@ -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';
 

diff --git a/common/standard/paths/u/user_delete.php b/common/standard/paths/u/user_delete.php
index a3c89f2..33bfb90 100644 (file)
--- a/common/standard/paths/u/user_delete.php
+++ b/common/standard/paths/u/user_delete.php
@@ -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';
 

diff --git a/common/standard/paths/u/user_edit.php b/common/standard/paths/u/user_edit.php
index 9a755f4..fe42382 100644 (file)
--- a/common/standard/paths/u/user_edit.php
+++ b/common/standard/paths/u/user_edit.php
@@ -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';
 

diff --git a/common/standard/paths/u/user_lock.php b/common/standard/paths/u/user_lock.php
index b418697..b6c9613 100644 (file)
--- a/common/standard/paths/u/user_lock.php
+++ b/common/standard/paths/u/user_lock.php
@@ -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';
 

diff --git a/common/standard/paths/u/user_pdf.php b/common/standard/paths/u/user_pdf.php
index b191fe8..aaa097b 100644 (file)
--- a/common/standard/paths/u/user_pdf.php
+++ b/common/standard/paths/u/user_pdf.php
@@ -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';
 

diff --git a/common/standard/paths/u/user_print.php b/common/standard/paths/u/user_print.php
index d310553..85edeec 100644 (file)
--- a/common/standard/paths/u/user_print.php
+++ b/common/standard/paths/u/user_print.php
@@ -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';
 

diff --git a/common/standard/paths/u/user_ps.php b/common/standard/paths/u/user_ps.php
index eda5323..9e80875 100644 (file)
--- a/common/standard/paths/u/user_ps.php
+++ b/common/standard/paths/u/user_ps.php
@@ -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';
 

diff --git a/common/standard/paths/u/user_settings.php b/common/standard/paths/u/user_settings.php
index 4612e2a..2d2dc05 100644 (file)
--- a/common/standard/paths/u/user_settings.php
+++ b/common/standard/paths/u/user_settings.php
@@ -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';
 

diff --git a/common/standard/paths/u/user_unlock.php b/common/standard/paths/u/user_unlock.php
index 1a93e04..0e56062 100644 (file)
--- a/common/standard/paths/u/user_unlock.php
+++ b/common/standard/paths/u/user_unlock.php
@@ -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';
 

diff --git a/common/standard/paths/u/user_view.php b/common/standard/paths/u/user_view.php
index 936179d..5e8d8bc 100644 (file)
--- a/common/standard/paths/u/user_view.php
+++ b/common/standard/paths/u/user_view.php
@@ -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';