From: Kaldari <kaldari@gmail.com>
Date: Sun, 29 Apr 2018 18:54:24 +0000 (-0700)
Subject: Better class documentation
X-Git-Tag: 1.34.0-rc.0~5576^2
X-Git-Url: https://git.cyclocoop.org/%27.WWW_URL.%27admin/?a=commitdiff_plain;h=2f713d5ff81ee045b964ba00fd2b8da3276586fc;p=lhc%2Fweb%2Fwiklou.git

Better class documentation

Change-Id: I25912f38bb483cd4636bff4ce219dc878a1046f3
---

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
  */