Add documentation for compute_total

stwe · Sep 7, 2019 · 4d39d8b · 4d39d8b
1 parent 7244a65
commit 4d39d8b
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/Datatable/Column/AbstractColumn.php b/Datatable/Column/AbstractColumn.php
@@ -1103,7 +1103,7 @@ public function getTotal()
     /**
      * Set total.
      *
-     * @param $total
+     * @param mixed $total
      *
      * @return $this
      */

diff --git a/Resources/doc/columns.md b/Resources/doc/columns.md
@@ -54,6 +54,7 @@ With 'null' initialized options uses the default value of the DataTables plugin.
 | mapped              | bool               | true              |          | Allow to create columns not mapped in entity neither defined by DQL. |
 | is_association      | bool               | false             |          | Allow to force if the column is an association, usally used with `mapped` and `data_source`. |
 | data_source         | null or string     | null              |          | Specify the column source of the data to manipulate in the current column. Usally used with `mapped` and `data_source`. | 
+| compute_total       | bool               | false             |          | Compute the total of numbers of all the row selected by the query. Totals will be displayed on a header row. |
 
 ### Example
 
@@ -761,6 +762,7 @@ public function buildDatatable(array $options = array())
 }
 ```
 
+
 ## 10. Link column
 
 Represents a column, with a link in each cell.