[Scummvm-git-logs] scummvm master -> 8d0aa01b1638d9d60c09f00f14c60287e468d385

[mduggan]

This automated email contains information about 1 new commit which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .

Summary:
8d0aa01b16 DEVTOOLS: Improve documentation for make_class.py


Commit: 8d0aa01b1638d9d60c09f00f14c60287e468d385
    https://github.com/scummvm/scummvm/commit/8d0aa01b1638d9d60c09f00f14c60287e468d385
Author: Matthew Duggan (mgithub at guarana.org)
Date: 2022-08-14T11:00:03+10:00

Commit Message:
DEVTOOLS: Improve documentation for make_class.py

Changed paths:
    devtools/README
    devtools/make_class.py


diff --git a/devtools/README b/devtools/README
index b8a258e3d96..05a1093f1cd 100644
--- a/devtools/README
+++ b/devtools/README
@@ -180,9 +180,10 @@ make_class.py
 	Examples:
 
 	$ make_class.py scumm . LeChuck
-	Make new class `LeChuck` in the scumm engine root (engines/scumm/).  Creates
-	boilerplate le_chuck.cpp and le_chuck.h containing class Scumm::LeChuck and
-	adds corresponding .o file to module.mk
+	Make new class `LeChuck` in the scumm engine root (engines/scumm/).
+	Creates boilerplate class Scumm::LeChuck, in le_chuck.cpp and le_chuck.h
+	(files are lower-cased, upper-case letters from class name get '_' added).
+	Adds corresponding .o file to module.mk list.
 
 	$ make_class.py -n BladeRunner bladerunner ui Scores
 	Make a new class BladeRunner::Scores in the engines/bladerunner/ui/
diff --git a/devtools/make_class.py b/devtools/make_class.py
index 73408a04570..c5413a5120d 100755
--- a/devtools/make_class.py
+++ b/devtools/make_class.py
@@ -197,7 +197,7 @@ def main():
 	parser = argparse.ArgumentParser(description=HELPTEXT)
 	parser.add_argument('engine', help='name of the engine')
 	parser.add_argument('subpath', help='subpath within the engine (use \'.\' to add to the engine root)')
-	parser.add_argument('classname', help='CamelCase name of the class to add')
+	parser.add_argument('classname', help='CamelCase name of the class to add. Filenames will be lower_case (capitals become _)')
 	parser.add_argument('--namespace', '-n', help='Namespace tp use (default is name of engine with a capital letter start)')
 
 	args = parser.parse_args()