Skip to content

Commit ed30795

Browse files
authored
Merge pull request #1590 from arasabbasi/fix_for_372
Fix for #372, Add Documentation Information
2 parents efdbc92 + 90ff922 commit ed30795

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

jspdf.js

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,12 @@
4848
* Creates new jsPDF document object instance.
4949
* @name jsPDF
5050
* @class
51-
* @param orientation One of "portrait" or "landscape" (or shortcuts "p" (Default), "l") <br />
51+
* @param orientation {String/Object} Orientation of the first page. Possible values are "portrait" or "landscape" (or shortcuts "p" (Default), "l") <br />
5252
* Can also be an options object.
53-
* @param unit Measurement unit to be used when coordinates are specified.
54-
* One of "pt" (points), "mm" (Default), "cm", "in"
55-
* @param format One of 'pageFormats' as shown below, default: a4
53+
* @param unit {String} Measurement unit to be used when coordinates are specified.<br />
54+
* Possible values are "pt" (points), "mm" (Default), "cm", "in" or "px".
55+
* @param format {String/Array} The format of the first page. Can be <ul><li>a0 - a10</li><li>b0 - b10</li><li>c0 - c10</li><li>c0 - c10</li><li>dl</li><li>letter</li><li>government-letter</li><li>legal</li><li>junior-legal</li><li>ledger</li><li>tabloid</li><li>credit-card</li></ul><br />
56+
* Default is "a4". If you want to use your own format just pass instead of one of the above predefined formats the size as an number-array , e.g. [595.28, 841.89]
5657
* @returns {jsPDF}
5758
* @description
5859
* If the first parameter (orientation) is an object, it will be interpreted as an object of named parameters
@@ -1349,6 +1350,9 @@ var jsPDF = (function(global) {
13491350

13501351
/**
13511352
* Adds (and transfers the focus to) new page to the PDF document.
1353+
* @param format {String/Array} The format of the new page. Can be <ul><li>a0 - a10</li><li>b0 - b10</li><li>c0 - c10</li><li>c0 - c10</li><li>dl</li><li>letter</li><li>government-letter</li><li>legal</li><li>junior-legal</li><li>ledger</li><li>tabloid</li><li>credit-card</li></ul><br />
1354+
* Default is "a4". If you want to use your own format just pass instead of one of the above predefined formats the size as an number-array , e.g. [595.28, 841.89]
1355+
* @param orientation {String} Orientation of the new page. Possible values are "portrait" or "landscape" (or shortcuts "p" (Default), "l")
13521356
* @function
13531357
* @returns {jsPDF}
13541358
*

0 commit comments

Comments
 (0)