Bug 1652846 - Clarify Documentation For Paper Interfaces r=jwatt
authorErik Nordin <nordzilla@mozilla.com>
Tue, 18 Aug 2020 17:58:53 +0000
changeset 545187 5e629ecc284688153d6652734177e338ebee73ca
parent 545186 13ab0525763e6ef70ebe10423c286120faa9f9ff
child 545188 25f0521ab3a1d879d630cf2fbefee643729e7cf5
push id37711
push usernbeleuzu@mozilla.com
push dateWed, 19 Aug 2020 10:01:16 +0000
treeherdermozilla-central@157db696462d [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersjwatt
bugs1652846
milestone81.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1652846 - Clarify Documentation For Paper Interfaces r=jwatt Clarify the comments to explain exactly what the paper sizes/margins refer to. Differential Revision: https://phabricator.services.mozilla.com/D86430
widget/nsIPaper.idl
--- a/widget/nsIPaper.idl
+++ b/widget/nsIPaper.idl
@@ -9,19 +9,27 @@
 interface nsIPaper : nsISupports
 {
   /**
    * The name of the paper.
    */
   readonly attribute AString name;
 
   /**
-   * The width of the paper in points.
+   * The width of the paper assuming portrait orientation, in points.
+   * That is, the length of the shorter edges of the paper.
    */
   readonly attribute double width;
 
   /**
-   * The height of the paper in points.
+   * The height of the paper assuming portrait orientation, in points.
+   * That is, the length of the longer edges of the paper.
    */
   readonly attribute double height;
 
+  /**
+   * The Promise resolves with an nsIPaperMargin object. The margin widths contained
+   * in that object's top/bottom/left/right properties are relative to the paper in
+   * portrait oriantation. That is, top and bottom are the margins for the short edges,
+   * and left and right are the margins for the long edges.
+   */
   [implicit_jscontext] readonly attribute Promise unwriteableMargin;
 };