3D-printing/Cura
1
0
Fork 0
mirror of https://github.com/Ultimaker/Cura.git synced 2025-07-16 11:17:49 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Update documentation

Browse source 
The doxygen documentation of the class and both its functions was also out of date.

Contributes to issue CURA-34.
This commit is contained in:
Ghostkeeper 2015-12-15 13:06:55 +01:00
parent fedfffb98d
commit 8947873121
1 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
plugins/GCodeProfileReader/GCodeProfileReader.py
View file

@ -8,15 +8,19 @@ import re #Regular expressions for parsing escape characters in the settings.
## A class that reads profile data from g-code files. ## A class that reads profile data from g-code files.
# #
# It reads the profile data from g-code files and stores the profile as a new # It reads the profile data from g-code files and stores it in a new profile.
# profile, and then immediately activates that profile.
# This class currently does not process the rest of the g-code in any way. # This class currently does not process the rest of the g-code in any way.
class GCodeProfileReader(ProfileReader): class GCodeProfileReader(ProfileReader):
## Initialises the g-code reader as a mesh reader. ## Initialises the g-code reader as a profile reader.
def __init__(self): def __init__(self):
super().__init__() super().__init__()
## Reads a g-code file, loading the profile from it. ## Reads a g-code file, loading the profile from it.
#
# \param file_name The name of the file to read the profile from.
# \return The profile that was in the specified file, if any. If the
# specified file was no g-code or contained no parsable profile, \code
# None \endcode is returned.
def read(self, file_name): def read(self, file_name):
version = 1 #IF YOU CHANGE THIS FUNCTION IN A WAY THAT BREAKS REVERSE COMPATIBILITY, INCREMENT THIS VERSION NUMBER! version = 1 #IF YOU CHANGE THIS FUNCTION IN A WAY THAT BREAKS REVERSE COMPATIBILITY, INCREMENT THIS VERSION NUMBER!
prefix = ";SETTING_" + str(version) + " " prefix = ";SETTING_" + str(version) + " "