Database driver task code documentation

Thanks! Good idea to fix up this documentation. A few issues in the patch:

a) This is not complete documentation: Return statements need a description.

+ *
+ * @return \Drupal\Core\Database\Install\Tasks
  */
 function db_installer_object($driver) {

b) This is not a documentation change -- if you mix documentation and non-documentation changes in a patch like this, I'll have to move it to "database system" and it will probably take more review etc. before it can be committed:

-  function checkBinaryOutput() {
+  public function checkBinaryOutput() {

Please put these changes in a separate issue.

c) I don't see this on the base class that is being extended:

+
+  /**
+   * {@inheritdoc}
+   */
   protected $pdoDriver = 'pgsql';

This occurs several times in the patch. It needs documentation and can't use inheritdoc unless there is documentation to inherit.

d) If you really want to clean up the documentaiton, most or all of the methods on the abstract base class do not follow our first-line verb coding standards (e.g., they should say "Checks..." not "Check"), and the class itself doesn't either. But if you want to not fix that in this patch, that is OK too.

#4 (a) still is a problem here. I'll review the patch once that is fixed.

Yes, return value descriptions are required. Something simple is fine, like "The node that was added." for a function like node_add().

+++ b/core/includes/install.inc
@@ -1103,6 +1103,9 @@ function db_run_tasks($driver) {
  *
  * @param $driver
  *   The name of the driver.
+ *
+ * @return \Drupal\Core\Database\Install\Tasks
+ *    Database-type specific installation tasks.
  */
 function db_installer_object($driver) {

How about for the @return description: A class defining the requirements and tasks for installing the database.

Everything else looks great.

Committed 50ce328 and pushed to 8.x. Thanks!

Quick follow-up needed:

  *   The name of the driver.
+ *
+ * @return \Drupal\Core\Database\Install\Tasks
+ *    A class defining the requirements and tasks for installing the database.
  */
 function db_installer_object($driver) {

This has too many spaces in the line after @return. Should only be indented two spaces beyond the @ in the previous line.

Thank you!

Thanks Xano - committed to 8.x.