Convert doxygen to rst for GcodeReader, GcodeGzReader/Writer,

GCodeProfileReader

1 files changed, 19 insertions, 14 deletions

diff --git a/plugins/GCodeGzWriter/GCodeGzWriter.py b/plugins/GCodeGzWriter/GCodeGzWriter.py
index cbbfb8f986..e9dcbad76b 100644
--- a/plugins/GCodeGzWriter/GCodeGzWriter.py
+++ b/plugins/GCodeGzWriter/GCodeGzWriter.py
@@ -13,26 +13,31 @@ from UM.Scene.SceneNode import SceneNode #For typing.
 from UM.i18n import i18nCatalog
 catalog = i18nCatalog("cura")
 
-##  A file writer that writes gzipped g-code.
-#
-#   If you're zipping g-code, you might as well use gzip!
+
 class GCodeGzWriter(MeshWriter):
+    """A file writer that writes gzipped g-code.
+    
+    If you're zipping g-code, you might as well use gzip!
+    """
+
 
     def __init__(self) -> None:
         super().__init__(add_to_recent_files = False)
 
-    ##  Writes the gzipped g-code to a stream.
-    #
-    #   Note that even though the function accepts a collection of nodes, the
-    #   entire scene is always written to the file since it is not possible to
-    #   separate the g-code for just specific nodes.
-    #
-    #   \param stream The stream to write the gzipped g-code to.
-    #   \param nodes This is ignored.
-    #   \param mode Additional information on what type of stream to use. This
-    #   must always be binary mode.
-    #   \return Whether the write was successful.
     def write(self, stream: BufferedIOBase, nodes: List[SceneNode], mode = MeshWriter.OutputMode.BinaryMode) -> bool:
+        """Writes the gzipped g-code to a stream.
+        
+        Note that even though the function accepts a collection of nodes, the
+        entire scene is always written to the file since it is not possible to
+        separate the g-code for just specific nodes.
+        
+        :param stream: The stream to write the gzipped g-code to.
+        :param nodes: This is ignored.
+        :param mode: Additional information on what type of stream to use. This
+            must always be binary mode.
+        :return: Whether the write was successful.
+        """
+
         if mode != MeshWriter.OutputMode.BinaryMode:
             Logger.log("e", "GCodeGzWriter does not support text mode.")
             self.setInformation(catalog.i18nc("@error:not supported", "GCodeGzWriter does not support text mode."))