Skip to content

Commit

Permalink
Improve documentation on Mesh idaholab#29484
Browse files Browse the repository at this point in the history
  • Loading branch information
kyriv1980 committed Oct 24, 2024
1 parent 2dacc05 commit 080bf63
Show file tree
Hide file tree
Showing 8 changed files with 4 additions and 60 deletions.
14 changes: 0 additions & 14 deletions modules/subchannel/doc/content/source/mesh/QuadInterWrapperMesh.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,7 @@
# QuadInterWrapperMesh

!alert construction title=Undocumented Class
The QuadInterWrapperMesh 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 a
MooseObject; however, what is contained is ultimately determined by what is necessary to make the
documentation clear for users.

!syntax description /Mesh/QuadInterWrapperMesh

## Overview

!! Replace these lines with information regarding the QuadInterWrapperMesh object.

## Example Input File Syntax

!! Describe and include an example of how to use the QuadInterWrapperMesh object.

!syntax parameters /Mesh/QuadInterWrapperMesh

!syntax inputs /Mesh/QuadInterWrapperMesh
Expand Down
14 changes: 0 additions & 14 deletions modules/subchannel/doc/content/source/mesh/QuadSubChannelMesh.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,7 @@
# QuadSubChannelMesh

!alert construction title=Undocumented Class
The QuadSubChannelMesh 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 a
MooseObject; however, what is contained is ultimately determined by what is necessary to make the
documentation clear for users.

!syntax description /Mesh/QuadSubChannelMesh

## Overview

!! Replace these lines with information regarding the QuadSubChannelMesh object.

## Example Input File Syntax

!! Describe and include an example of how to use the QuadSubChannelMesh object.

!syntax parameters /Mesh/QuadSubChannelMesh

!syntax inputs /Mesh/QuadSubChannelMesh
Expand Down
14 changes: 0 additions & 14 deletions modules/subchannel/doc/content/source/mesh/TriInterWrapperMesh.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,7 @@
# TriInterWrapperMesh

!alert construction title=Undocumented Class
The TriInterWrapperMesh 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 a
MooseObject; however, what is contained is ultimately determined by what is necessary to make the
documentation clear for users.

!syntax description /Mesh/TriInterWrapperMesh

## Overview

!! Replace these lines with information regarding the TriInterWrapperMesh object.

## Example Input File Syntax

!! Describe and include an example of how to use the TriInterWrapperMesh object.

!syntax parameters /Mesh/TriInterWrapperMesh

!syntax inputs /Mesh/TriInterWrapperMesh
Expand Down
14 changes: 0 additions & 14 deletions modules/subchannel/doc/content/source/mesh/TriSubChannelMesh.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,7 @@
# TriSubChannelMesh

!alert construction title=Undocumented Class
The TriSubChannelMesh 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 a
MooseObject; however, what is contained is ultimately determined by what is necessary to make the
documentation clear for users.

!syntax description /Mesh/TriSubChannelMesh

## Overview

!! Replace these lines with information regarding the TriSubChannelMesh object.

## Example Input File Syntax

!! Describe and include an example of how to use the TriSubChannelMesh object.

!syntax parameters /Mesh/TriSubChannelMesh

!syntax inputs /Mesh/TriSubChannelMesh
Expand Down
2 changes: 1 addition & 1 deletion modules/subchannel/src/mesh/QuadInterWrapperMesh.C
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ InputParameters
QuadInterWrapperMesh::validParams()
{
InputParameters params = InterWrapperMesh::validParams();
params.addClassDescription("Creates an inter-wrappper mesh container arround a square "
params.addClassDescription("Creates an inter-wrappper mesh container for a square "
"lattice subchannel arrangement");
return params;
}
Expand Down
2 changes: 1 addition & 1 deletion modules/subchannel/src/mesh/QuadSubChannelMesh.C
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ InputParameters
QuadSubChannelMesh::validParams()
{
InputParameters params = SubChannelMesh::validParams();
params.addClassDescription("Creates an subchannel mesh container in a square "
params.addClassDescription("Creates an subchannel mesh container for a square "
"lattice arrangement");
return params;
}
Expand Down
2 changes: 1 addition & 1 deletion modules/subchannel/src/mesh/TriInterWrapperMesh.C
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ InputParameters
TriInterWrapperMesh::validParams()
{
InputParameters params = InterWrapperMesh::validParams();
params.addClassDescription("Creates an inter-wrappper mesh container arround a triangular "
params.addClassDescription("Creates an inter-wrappper mesh container for a triangular "
"lattice subchannel arrangement");
return params;
}
Expand Down
2 changes: 1 addition & 1 deletion modules/subchannel/src/mesh/TriSubChannelMesh.C
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ InputParameters
TriSubChannelMesh::validParams()
{
InputParameters params = SubChannelMesh::validParams();
params.addClassDescription("Creates an subchannel mesh container in a triangular "
params.addClassDescription("Creates an subchannel mesh container for a triangular "
"lattice arrangement");
return params;
}
Expand Down

0 comments on commit 080bf63

Please sign in to comment.