Browse Source

Minor - Add comment on PDF download types - refs BT#9461

Yannick Warnier 10 years ago
parent
commit
add6ef41fc
1 changed files with 5 additions and 3 deletions
  1. 5 3
      main/inc/lib/pdf.lib.php

+ 5 - 3
main/inc/lib/pdf.lib.php

@@ -345,9 +345,11 @@ class PDF
      * @param   string $pdf_name pdf name
      * @param   string $course_code course code
      * (if you are using html that are located in the document tool you must provide this)
-     * @param string $outputMode the output mode can be:
-     * 'I', 'D', 'F', 'S'
-     * by default is 'D'
+     * @param string $outputMode the MPDF output mode can be:
+     * 'I' (print on standard output),
+     * 'D' (download file) (this is the default value),
+     * 'F' (save to local file) or
+     * 'S' (return as a string)
      * @return  string  Web path
      */
     public function content_to_pdf(