Improve documentation on actions idaholab#29484

modules/subchannel/doc/content/source/actions/QuadInterWrapperBuildMeshAction.md

@@ -1,21 +1,5 @@
 # QuadInterWrapperBuildMeshAction
 
-!alert construction title=Undocumented Action Class
-The QuadInterWrapperBuildMeshAction has not been documented. The content listed below should be used as a starting point for
-documenting the class, which includes the typical automatic documentation associated with an Action;
-however, what is contained is ultimately determined by what is necessary to make the documentation
-clear for users.
-
-!syntax description /QuadInterWrapperMesh/QuadInterWrapperBuildMeshAction
-
-## Overview
-
-!! Replace these lines with information regarding the QuadInterWrapperBuildMeshAction action.
-
-## Example Input File Syntax
-
-!! Describe and include an example of how to use the QuadInterWrapperBuildMeshAction action.
-
 !syntax description /QuadInterWrapperMesh/QuadInterWrapperBuildMeshAction
 
 !syntax parameters /QuadInterWrapperMesh/QuadInterWrapperBuildMeshAction

modules/subchannel/doc/content/source/actions/QuadSubChannelBuildMeshAction.md

@@ -1,21 +1,5 @@
 # QuadSubChannelBuildMeshAction
 
-!alert construction title=Undocumented Action Class
-The QuadSubChannelBuildMeshAction has not been documented. The content listed below should be used as a starting point for
-documenting the class, which includes the typical automatic documentation associated with an Action;
-however, what is contained is ultimately determined by what is necessary to make the documentation
-clear for users.
-
-!syntax description /QuadSubChannelMesh/QuadSubChannelBuildMeshAction
-
-## Overview
-
-!! Replace these lines with information regarding the QuadSubChannelBuildMeshAction action.
-
-## Example Input File Syntax
-
-!! Describe and include an example of how to use the QuadSubChannelBuildMeshAction action.
-
 !syntax description /QuadSubChannelMesh/QuadSubChannelBuildMeshAction
 
 !syntax parameters /QuadSubChannelMesh/QuadSubChannelBuildMeshAction

modules/subchannel/doc/content/source/actions/SubChannelAddVariablesAction.md

@@ -1,21 +1,5 @@
 # SubChannelAddVariablesAction
 
-!alert construction title=Undocumented Action Class
-The SubChannelAddVariablesAction has not been documented. The content listed below should be used as a starting point for
-documenting the class, which includes the typical automatic documentation associated with an Action;
-however, what is contained is ultimately determined by what is necessary to make the documentation
-clear for users.
-
-!syntax description /SubChannel/SubChannelAddVariablesAction
-
-## Overview
-
-!! Replace these lines with information regarding the SubChannelAddVariablesAction action.
-
-## Example Input File Syntax
-
-!! Describe and include an example of how to use the SubChannelAddVariablesAction action.
-
 !syntax description /SubChannel/SubChannelAddVariablesAction
 
 !syntax parameters /SubChannel/SubChannelAddVariablesAction

modules/subchannel/doc/content/source/actions/SubChannelCreateProblemAction.md

@@ -1,21 +1,5 @@
 # SubChannelCreateProblemAction
 
-!alert construction title=Undocumented Action Class
-The SubChannelCreateProblemAction has not been documented. The content listed below should be used as a starting point for
-documenting the class, which includes the typical automatic documentation associated with an Action;
-however, what is contained is ultimately determined by what is necessary to make the documentation
-clear for users.
-
-!syntax description /SubChannel/SubChannelCreateProblemAction
-
-## Overview
-
-!! Replace these lines with information regarding the SubChannelCreateProblemAction action.
-
-## Example Input File Syntax
-
-!! Describe and include an example of how to use the SubChannelCreateProblemAction action.
-
 !syntax description /SubChannel/SubChannelCreateProblemAction
 
 !syntax parameters /SubChannel/SubChannelCreateProblemAction

modules/subchannel/doc/content/source/actions/TriInterWrapperBuildMeshAction.md

@@ -1,21 +1,5 @@
 # TriInterWrapperBuildMeshAction
 
-!alert construction title=Undocumented Action Class
-The TriInterWrapperBuildMeshAction has not been documented. The content listed below should be used as a starting point for
-documenting the class, which includes the typical automatic documentation associated with an Action;
-however, what is contained is ultimately determined by what is necessary to make the documentation
-clear for users.
-
-!syntax description /TriInterWrapperMesh/TriInterWrapperBuildMeshAction
-
-## Overview
-
-!! Replace these lines with information regarding the TriInterWrapperBuildMeshAction action.
-
-## Example Input File Syntax
-
-!! Describe and include an example of how to use the TriInterWrapperBuildMeshAction action.
-
 !syntax description /TriInterWrapperMesh/TriInterWrapperBuildMeshAction
 
 !syntax parameters /TriInterWrapperMesh/TriInterWrapperBuildMeshAction

modules/subchannel/doc/content/source/actions/TriSubChannelBuildMeshAction.md

@@ -1,21 +1,5 @@
 # TriSubChannelBuildMeshAction
 
-!alert construction title=Undocumented Action Class
-The TriSubChannelBuildMeshAction has not been documented. The content listed below should be used as a starting point for
-documenting the class, which includes the typical automatic documentation associated with an Action;
-however, what is contained is ultimately determined by what is necessary to make the documentation
-clear for users.
-
-!syntax description /TriSubChannelMesh/TriSubChannelBuildMeshAction
-
-## Overview
-
-!! Replace these lines with information regarding the TriSubChannelBuildMeshAction action.
-
-## Example Input File Syntax
-
-!! Describe and include an example of how to use the TriSubChannelBuildMeshAction action.
-
 !syntax description /TriSubChannelMesh/TriSubChannelBuildMeshAction
 
 !syntax parameters /TriSubChannelMesh/TriSubChannelBuildMeshAction

modules/subchannel/src/actions/QuadInterWrapperBuildMeshAction.C

@@ -23,8 +23,8 @@ InputParameters
 QuadInterWrapperBuildMeshAction::validParams()
 {
   InputParameters params = Action::validParams();
-  params.addClassDescription(
-      "Builds the infastructure for the wrapper mesh in the square lattice arrangement");
+  params.addClassDescription("Creates the infastructure necessary to build the inter-wrapper mesh "
+                             "in the square lattice arrangement");
   return params;
 }
 

modules/subchannel/src/actions/QuadSubChannelBuildMeshAction.C

@@ -23,8 +23,8 @@ InputParameters
 QuadSubChannelBuildMeshAction::validParams()
 {
   InputParameters params = Action::validParams();
-  params.addClassDescription(
-      "Builds the infastructure for the subchannel mesh in the square lattice arrangement");
+  params.addClassDescription("Creates the infastructure necessary to buidl the subchannel mesh in "
+                             "the square lattice arrangement");
   return params;
 }
 

modules/subchannel/src/actions/TriInterWrapperBuildMeshAction.C

@@ -23,8 +23,8 @@ InputParameters
 TriInterWrapperBuildMeshAction::validParams()
 {
   InputParameters params = Action::validParams();
-  params.addClassDescription(
-      "Builds the infastructure for the wrapper mesh in the triangular lattice arrangement");
+  params.addClassDescription("Creates the infastructure necessary to build the inter-wrapper mesh "
+                             "in the triangular lattice arrangement");
   return params;
 }
 

modules/subchannel/src/actions/TriSubChannelBuildMeshAction.C

@@ -23,8 +23,8 @@ InputParameters
 TriSubChannelBuildMeshAction::validParams()
 {
   InputParameters params = Action::validParams();
-  params.addClassDescription(
-      "Builds the infastructure for the subchannel mesh in the triangular lattice arrangement");
+  params.addClassDescription("Creates the infastructure necessary to build the subchannel mesh in "
+                             "the triangular lattice arrangement");
   return params;
 }