Add documentation

CURA-12446

Author: wawanbreton

include/FffGcodeWriter.h

@@ -322,6 +322,7 @@ class FffGcodeWriter : public NoCopy
      *
      * \param[in] storage where the slice data is stored.
      * \param mesh_ptr The mesh to add to the layer plan \p gcode_layer.
+     * \param slice_layer The layer currently being processed
      * \param extruder_nr The extruder for which to print all features of the mesh which should be printed with this extruder
      * \param mesh_config the line config with which to print a print feature
      * \param gcode_layer The initial planning of the gcode of the layer.
@@ -341,6 +342,7 @@ class FffGcodeWriter : public NoCopy
      * \param[in] storage where the slice data is stored.
      * \param storage Storage to get global settings from.
      * \param mesh The mesh to add to the layer plan \p gcode_layer.
+     * \param slice_layer The layer currently being processed
      * \param extruder_nr The extruder for which to print all features of the mesh which should be printed with this extruder
      * \param mesh_config the line config with which to print a print feature
      * \param part The part to add
@@ -360,6 +362,7 @@ class FffGcodeWriter : public NoCopy
      *
      * \param gcodeLayer The initial planning of the gcode of the layer.
      * \param mesh The mesh for which to add to the layer plan \p gcodeLayer.
+     * \param slice_layer The layer currently being processed
      * \param extruder_nr The extruder for which to print all features of the
      * mesh which should be printed with this extruder.
      * \param mesh_config the line config with which to print a print feature.
@@ -384,7 +387,8 @@ class FffGcodeWriter : public NoCopy
      * \param gcodeLayer The initial planning of the gcode of the layer.
      * \param mesh The mesh for which to add to the layer plan \p gcodeLayer.
      * \param extruder_nr The extruder for which to print all features of the
-     * mesh which should be printed with this extruder.
+     * \param mesh which should be printed with this extruder.
+     * \param slice_layer The layer currently being processed
      * \param mesh_config The line config with which to print a print feature.
      * \param part The part for which to create gcode.
      * \param start_move_inwards_length The length of the extra inwards moves to be added at the start of each infill line
@@ -410,7 +414,8 @@ class FffGcodeWriter : public NoCopy
      * \param gcodeLayer The initial planning of the gcode of the layer.
      * \param mesh The mesh for which to add to the layer plan \p gcodeLayer.
      * \param extruder_nr The extruder for which to print all features of the
-     * mesh which should be printed with this extruder
+     * \param mesh which should be printed with this extruder
+     * \param slice_layer The layer currently being processed
      * \param mesh_config The line config with which to print a print feature.
      * \param part The part for which to create gcode.
      * \param start_move_inwards_length The length of the extra inwards moves to be added at the start of each infill line
@@ -492,6 +497,7 @@ class FffGcodeWriter : public NoCopy
      * \param[in] storage where the slice data is stored.
      * \param gcode_layer The initial planning of the gcode of the layer.
      * \param mesh The mesh for which to add to the layer plan \p gcode_layer.
+     * \param slice_layer The layer currently being processed
      * \param extruder_nr The extruder for which to print all features of the mesh which should be printed with this extruder
      * \param mesh_config the line config with which to print a print feature
      * \param part The part for which to create gcode
@@ -522,6 +528,7 @@ class FffGcodeWriter : public NoCopy
      * \param[in] storage where the slice data is stored.
      * \param gcode_layer The initial planning of the gcode of the layer.
      * \param mesh The mesh for which to add to the layer plan \p gcode_layer.
+     * \param slice_layer The layer currently being processed
      * \param extruder_nr The extruder for which to print all features of the mesh which should be printed with this extruder
      * \param mesh_config the line config with which to print a print feature
      * \param skin_part The skin part for which to create gcode
@@ -566,6 +573,7 @@ class FffGcodeWriter : public NoCopy
      * \param[in] storage where the slice data is stored.
      * \param gcode_layer The initial planning of the gcode of the layer.
      * \param mesh The mesh for which to add to the layer plan \p gcode_layer.
+     * \param slice_layer The layer currently being processed
      * \param extruder_nr The extruder for which to print all features of the mesh which should be printed with this extruder
      * \param mesh_config the line config with which to print a print feature
      * \param skin_fill The shape of the skin for which to create gcode

include/infill/LightningGenerator.h

@@ -69,6 +69,7 @@ class LightningGenerator // "Just like Nicola used to make!"
     const LightningLayer& getTreesForLayer(const size_t& layer_id) const;
 
 protected:
+    /*! Helper structure to get the infill wall line count either from a fixed value or depending on the layer */
     struct WallLineCount : std::variant<size_t, const std::vector<SliceLayer>*>
     {
         WallLineCount(const size_t fixed_count)

include/sliceDataStorage.h

@@ -184,11 +184,11 @@ class SliceLayer
      */
     Shape bottom_surface;
 
-    size_t outer_wall_count{ 0 };
-    size_t extra_wall_count_infill{ 0 };
-    size_t extra_wall_count_skin{ 0 };
-    size_t extra_wall_count_flooring{ 0 };
-    size_t extra_wall_count_roofing{ 0 };
+    size_t outer_wall_count{ 0 }; //!< The number of walls printed on the outer contour of the model, common to all areas
+    size_t extra_wall_count_infill{ 0 }; //!< The extra number of walls printed around infill areas
+    size_t extra_wall_count_skin{ 0 }; //!< The extra number of walls printed around skin areas
+    size_t extra_wall_count_flooring{ 0 }; //!< The extra number of walls printed around flooring areas
+    size_t extra_wall_count_roofing{ 0 }; //!< The extra number of walls printed around roofing areas
 
     /*!
      * Get the all outlines of all layer parts in this layer.