From 2f713d5ff81ee045b964ba00fd2b8da3276586fc Mon Sep 17 00:00:00 2001 From: Kaldari Date: Sun, 29 Apr 2018 11:54:24 -0700 Subject: [PATCH] Better class documentation Change-Id: I25912f38bb483cd4636bff4ce219dc878a1046f3 --- includes/logging/LogEntry.php | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/includes/logging/LogEntry.php b/includes/logging/LogEntry.php index e17ac032aa..54a41bab0b 100644 --- a/includes/logging/LogEntry.php +++ b/includes/logging/LogEntry.php @@ -156,7 +156,8 @@ abstract class LogEntryBase implements LogEntry { } /** - * This class wraps around database result row. + * A value class to process existing log entries. In other words, this class caches a log + * entry from the database and provides an immutable object-oriented representation of it. * * @since 1.19 */ @@ -361,6 +362,10 @@ class DatabaseLogEntry extends LogEntryBase { } } +/** + * A subclass of DatabaseLogEntry for objects constructed from entries in the + * recentchanges table (rather than the logging table). + */ class RCDatabaseLogEntry extends DatabaseLogEntry { public function getId() { @@ -425,7 +430,7 @@ class RCDatabaseLogEntry extends DatabaseLogEntry { } /** - * Class for creating log entries manually, to inject them into the database. + * Class for creating new log entries and inserting them into the database. * * @since 1.19 */ -- 2.20.1