Add missing documentation for GCODE analysis and other small fixes

Adds documentation for `dimensions` and `printingArea`; fixes `length` and `volume`; adds two internal references. Fixes #2463.
OctoPrint · Apr 3, 2018 · 6ec8b97 · 6ec8b97
1 parent 2152c40
commit 6ec8b97
Showing 1 changed file with 53 additions and 5 deletions.
diff --git a/docs/api/datamodel.rst b/docs/api/datamodel.rst
@@ -263,8 +263,11 @@ File information
      - Path to type of file in extension tree. E.g. ``["model", "stl"]`` for ``.stl`` files, or ``["machinecode", "gcode"]``
        for ``.gcode`` files. ``["folder"]`` for folders.
 
-Additional properties depend on ``type``. For a ``type`` value of ``folder``, see "Folders". For any other value
-see "Files".
+Additional properties depend on ``type``.
+For a ``type`` value of ``folder``, see :ref:`Folders <sec-api-datamodel-files-folders>`.
+For any other value see :ref:`Files <sec-api-datamodel-files-files>`.
+
+.. _sec-api-datamodel-files-folders:
 
 Folders
 '''''''
@@ -287,6 +290,8 @@ Folders
      - Number
      - The size of all files contained in the folder and its subfolders. Not present in non recursive listings!
 
+.. _sec-api-datamodel-files-files:
+
 Files
 '''''
 
@@ -384,14 +389,58 @@ GCODE analysis information
      - 0..1
      - Object
      - The estimated usage of filament
-   * - ``filament.length``
+   * - ``filament.tool{n}.length``
      - 0..1
      - Integer
      - The length of filament used, in mm
-   * - ``filament.volume``
+   * - ``filament.tool{n}.volume``
      - 0..1
      - Float
      - The volume of filament used, in cm³
+   * - ``dimensions``
+     - 0..1
+     - Object
+     - Information regarding the size of the printed model
+   * - ``dimensions.depth``
+     - 0..1
+     - Float
+     - The depth of the printed model, in mm
+   * - ``dimensions.height``
+     - 0..1
+     - Float
+     - The height of the printed model, in mm
+   * - ``dimensions.width``
+     - 0..1
+     - Float
+     - The width of the printed model, in mm
+   * - ``printingArea``
+     - 0..1
+     - Object
+     - Information regarding the size of the printing area
+   * - ``printingArea.maxX``
+     - 0..1
+     - Float
+     - The maximum X coordinate of the printed model, in mm
+   * - ``printingArea.maxY``
+     - 0..1
+     - Float
+     - The maximum Y coordinate of the printed model, in mm
+   * - ``printingArea.maxZ``
+     - 0..1
+     - Float
+     - The maximum Z coordinate of the printed model, in mm
+   * - ``printingArea.minX``
+     - 0..1
+     - Float
+     - The minimum X coordinate of the printed model, in mm
+   * - ``printingArea.minY``
+     - 0..1
+     - Float
+     - The minimum Y coordinate of the printed model, in mm
+   * - ``printingArea.minZ``
+     - 0..1
+     - Float
+     - The minimum Z coordinate of the printed model, in mm
 
 
 .. _sec-api-datamodel-files-ref:
@@ -420,4 +469,3 @@ References
      - URL
      - The model from which this file was generated (e.g. an STL, currently not used). Never present for
        folders.
-