Improve comment readability

dziegel · Jan 25, 2024 · 1f9d1cc · 1f9d1cc
1 parent fee5b61
commit 1f9d1cc
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 22 deletions.
diff --git a/generator/src/generator/DeclarationState.egl b/generator/src/generator/DeclarationState.egl
@@ -1,4 +1,4 @@
-// State [%=state.name%]
+// State [%=state.readable_scoped_name%]
 static const [%=state.state_type%] [%=state.variable_name%];
 [%
   if(state.region.isDefined()) {

diff --git a/generator/src/generator/InstanceState.egl b/generator/src/generator/InstanceState.egl
@@ -3,7 +3,7 @@
   handlerTemplate.populate("state", state);
   handlerTemplate.populate("statemachine", statemachine);
 %]
-// State [%=state.name%]
+// State [%=state.readable_scoped_name%]
 [%=handlerTemplate.process()%]
 const [%=statemachine.name%]::[%=state.state_type%] [%=statemachine.name%]::[%=state.variable_name%]("[%=state.readable_scoped_name%]", &[%=state.scoped_name%]Handler, [%=state.parent_variable_pointer%], [%=state.initial_variable_pointer%], [%=state.entry_pointer%], [%=state.exit_pointer%]);
 [%

diff --git a/test/generated/ScXmlTestDeclaration.hxx b/test/generated/ScXmlTestDeclaration.hxx
@@ -10,18 +10,18 @@ class ScXmlTest final : public ScXmlTestBase
 	// State State_1
 	static const State kState_1;
 
-	// State State_2
+	// State State_1::State_2
 	static const State kState_1State_2;
 
-	// State State_3
+	// State State_1::State_3
 	static const State kState_1State_3;
 
-	// State State_4
+	// State State_1::State_4
 	static const HistoryState kState_1State_4;
 
-	// State State_5
+	// State State_1::State_4::State_5
 	static const State kState_1State_4State_5;
 
-	// State State_6
+	// State State_1::State_4::State_6
 	static const State kState_1State_4State_6;
 };
diff --git a/test/generated/ScXmlTestInstance.hxx b/test/generated/ScXmlTestInstance.hxx
@@ -26,7 +26,7 @@ static ScXmlTest::Transition State_1Handler(ScXmlTest::ImplPtr impl, ScXmlTest::
 }
 const ScXmlTest::State ScXmlTest::kState_1("State_1", &State_1Handler, nullptr, &ScXmlTest::kState_1State_2, &ScXmlTest::Impl::State1OnEntry, nullptr);
 
-// State State_2
+// State State_1::State_2
 static ScXmlTest::Transition State_1State_2Handler(ScXmlTest::ImplPtr impl, ScXmlTest::Event event)
 {
 	(void)impl; // impl parameter is unused when there is no guard function being called in here
@@ -62,7 +62,7 @@ static ScXmlTest::Transition State_1State_2Handler(ScXmlTest::ImplPtr impl, ScXm
 }
 const ScXmlTest::State ScXmlTest::kState_1State_2("State_1::State_2", &State_1State_2Handler, &ScXmlTest::kState_1, nullptr, &ScXmlTest::Impl::State2OnEntry, nullptr);
 
-// State State_3
+// State State_1::State_3
 static ScXmlTest::Transition State_1State_3Handler(ScXmlTest::ImplPtr impl, ScXmlTest::Event event)
 {
 	(void)impl; // impl parameter is unused when there is no guard function being called in here
@@ -82,7 +82,7 @@ static ScXmlTest::Transition State_1State_3Handler(ScXmlTest::ImplPtr impl, ScXm
 }
 const ScXmlTest::State ScXmlTest::kState_1State_3("State_1::State_3", &State_1State_3Handler, &ScXmlTest::kState_1, nullptr, &ScXmlTest::Impl::State3OnEntry, &ScXmlTest::Impl::State3OnExit);
 
-// State State_4
+// State State_1::State_4
 static ScXmlTest::Transition State_1State_4Handler(ScXmlTest::ImplPtr impl, ScXmlTest::Event event)
 {
 	(void)impl; // impl parameter is unused when there is no guard function being called in here
@@ -102,7 +102,7 @@ static ScXmlTest::Transition State_1State_4Handler(ScXmlTest::ImplPtr impl, ScXm
 }
 const ScXmlTest::HistoryState ScXmlTest::kState_1State_4("State_1::State_4", &State_1State_4Handler, &ScXmlTest::kState_1, &ScXmlTest::kState_1State_4State_5, &ScXmlTest::Impl::State4OnEntry, &ScXmlTest::Impl::State4OnExit);
 
-// State State_5
+// State State_1::State_4::State_5
 static ScXmlTest::Transition State_1State_4State_5Handler(ScXmlTest::ImplPtr impl, ScXmlTest::Event event)
 {
 	(void)impl; // impl parameter is unused when there is no guard function being called in here
@@ -122,7 +122,7 @@ static ScXmlTest::Transition State_1State_4State_5Handler(ScXmlTest::ImplPtr imp
 }
 const ScXmlTest::State ScXmlTest::kState_1State_4State_5("State_1::State_4::State_5", &State_1State_4State_5Handler, &ScXmlTest::kState_1State_4, nullptr, nullptr, nullptr);
 
-// State State_6
+// State State_1::State_4::State_6
 static ScXmlTest::Transition State_1State_4State_6Handler(ScXmlTest::ImplPtr impl, ScXmlTest::Event event)
 {
 	(void)impl; // impl parameter is unused when there is no guard function being called in here

diff --git a/test/generated/XmiTestDeclaration.hxx b/test/generated/XmiTestDeclaration.hxx
@@ -10,18 +10,18 @@ class XmiTest final : public XmiTestBase
 	// State State_1
 	static const State kState_1;
 
-	// State StateWithSameName
+	// State State_1::StateWithSameName
 	static const State kState_1StateWithSameName;
 
-	// State State_2
+	// State State_1::State_2
 	static const State kState_1State_2;
 
-	// State State_4
+	// State State_1::State_4
 	static const HistoryState kState_1State_4;
 
-	// State StateWithSameName
+	// State State_1::State_4::StateWithSameName
 	static const State kState_1State_4StateWithSameName;
 
-	// State State_5
+	// State State_1::State_4::State_5
 	static const State kState_1State_4State_5;
 };
diff --git a/test/generated/XmiTestInstance.hxx b/test/generated/XmiTestInstance.hxx
@@ -26,7 +26,7 @@ static XmiTest::Transition State_1Handler(XmiTest::ImplPtr impl, XmiTest::Event
 }
 const XmiTest::State XmiTest::kState_1("State_1", &State_1Handler, nullptr, &XmiTest::kState_1State_2, &XmiTest::Impl::State1OnEntry, nullptr);
 
-// State StateWithSameName
+// State State_1::StateWithSameName
 static XmiTest::Transition State_1StateWithSameNameHandler(XmiTest::ImplPtr impl, XmiTest::Event event)
 {
 	(void)impl; // impl parameter is unused when there is no guard function being called in here
@@ -46,7 +46,7 @@ static XmiTest::Transition State_1StateWithSameNameHandler(XmiTest::ImplPtr impl
 }
 const XmiTest::State XmiTest::kState_1StateWithSameName("State_1::StateWithSameName", &State_1StateWithSameNameHandler, &XmiTest::kState_1, nullptr, &XmiTest::Impl::State3OnEntry, &XmiTest::Impl::State3OnExit);
 
-// State State_2
+// State State_1::State_2
 static XmiTest::Transition State_1State_2Handler(XmiTest::ImplPtr impl, XmiTest::Event event)
 {
 	(void)impl; // impl parameter is unused when there is no guard function being called in here
@@ -82,7 +82,7 @@ static XmiTest::Transition State_1State_2Handler(XmiTest::ImplPtr impl, XmiTest:
 }
 const XmiTest::State XmiTest::kState_1State_2("State_1::State_2", &State_1State_2Handler, &XmiTest::kState_1, nullptr, &XmiTest::Impl::State2OnEntry, nullptr);
 
-// State State_4
+// State State_1::State_4
 static XmiTest::Transition State_1State_4Handler(XmiTest::ImplPtr impl, XmiTest::Event event)
 {
 	(void)impl; // impl parameter is unused when there is no guard function being called in here
@@ -102,7 +102,7 @@ static XmiTest::Transition State_1State_4Handler(XmiTest::ImplPtr impl, XmiTest:
 }
 const XmiTest::HistoryState XmiTest::kState_1State_4("State_1::State_4", &State_1State_4Handler, &XmiTest::kState_1, &XmiTest::kState_1State_4State_5, &XmiTest::Impl::State4OnEntry, &XmiTest::Impl::State4OnExit);
 
-// State StateWithSameName
+// State State_1::State_4::StateWithSameName
 static XmiTest::Transition State_1State_4StateWithSameNameHandler(XmiTest::ImplPtr impl, XmiTest::Event event)
 {
 	(void)impl; // impl parameter is unused when there is no guard function being called in here
@@ -122,7 +122,7 @@ static XmiTest::Transition State_1State_4StateWithSameNameHandler(XmiTest::ImplP
 }
 const XmiTest::State XmiTest::kState_1State_4StateWithSameName("State_1::State_4::StateWithSameName", &State_1State_4StateWithSameNameHandler, &XmiTest::kState_1State_4, nullptr, nullptr, nullptr);
 
-// State State_5
+// State State_1::State_4::State_5
 static XmiTest::Transition State_1State_4State_5Handler(XmiTest::ImplPtr impl, XmiTest::Event event)
 {
 	(void)impl; // impl parameter is unused when there is no guard function being called in here