PageEditStash: Minor docs and code clean up

* Move description from PHP file docblock to class docblock, where
  IDEs and Doxygen actually read it form.

* Add cross-references.

* Use more consistent terminology.

* Switch to newer coding convention for variable declarations
  in stash.js.

Bug: T189824
Change-Id: I216d85c6dfed3205ec5692a9e0dfa0e9d5d2b9ab

1 files changed, 6 insertions, 4 deletions

diff --git a/includes/Storage/PageEditStash.php b/includes/Storage/PageEditStash.php
index ad6df647bd40..e8f89252f9ec 100644
--- a/includes/Storage/PageEditStash.php
+++ b/includes/Storage/PageEditStash.php
@@ -1,7 +1,5 @@
 <?php
 /**
- * Predictive edit preparation system for MediaWiki page.
- *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
@@ -43,7 +41,12 @@ use Wikimedia\ScopedCallback;
 use WikiPage;
 
 /**
- * Class for managing stashed edits used by the page updater classes
+ * Manage the pre-emptive page parsing for edits to wiki pages.
+ *
+ * This is written to by ApiStashEdit, and consumed by ApiEditPage
+ * and EditPage (via PageUpdaterFactory and DerivedPageDataUpdater).
+ *
+ * See also mediawiki.action.edit/stash.js.
  *
  * @since 1.34
  */
@@ -64,7 +67,6 @@ class PageEditStash {
 	private $userFactory;
 	/** @var WikiPageFactory */
 	private $wikiPageFactory;
-
 	/** @var int */
 	private $initiator;