SQA: fixup documentation stubs

Refs idaholab#73
cticenhour · Oct 11, 2023 · 4daaacd · 4daaacd
1 parent c20a85c
commit 4daaacd
Show file tree

Hide file tree

Showing 13 changed files with 26 additions and 104 deletions.
diff --git a/doc/content/source/bcs/DisplaceBoundaryBC.md b/doc/content/source/bcs/DisplaceBoundaryBC.md
@@ -1,18 +1,12 @@
 # DisplaceBoundaryBC
 
-!alert construction title=Undocumented Class
-The DisplaceBoundaryBC 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 /BCs/DisplaceBoundaryBC
 
-## Overview
+!! ## Overview
 
 !! Replace these lines with information regarding the DisplaceBoundaryBC object.
 
-## Example Input File Syntax
+!! ## Example Input File Syntax
 
 !! Describe and include an example of how to use the DisplaceBoundaryBC object.
 

diff --git a/doc/content/source/bcs/GaussianWeldEnergyFluxBC.md b/doc/content/source/bcs/GaussianWeldEnergyFluxBC.md
@@ -1,18 +1,12 @@
 # GaussianWeldEnergyFluxBC
 
-!alert construction title=Undocumented Class
-The GaussianWeldEnergyFluxBC 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 /BCs/GaussianWeldEnergyFluxBC
 
-## Overview
+!! ## Overview
 
 !! Replace these lines with information regarding the GaussianWeldEnergyFluxBC object.
 
-## Example Input File Syntax
+!! ## Example Input File Syntax
 
 !! Describe and include an example of how to use the GaussianWeldEnergyFluxBC object.
 

diff --git a/doc/content/source/bcs/PenaltyDisplaceBoundaryBC.md b/doc/content/source/bcs/PenaltyDisplaceBoundaryBC.md
@@ -1,18 +1,12 @@
 # PenaltyDisplaceBoundaryBC
 
-!alert construction title=Undocumented Class
-The PenaltyDisplaceBoundaryBC 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 /BCs/PenaltyDisplaceBoundaryBC
 
-## Overview
+!! ## Overview
 
 !! Replace these lines with information regarding the PenaltyDisplaceBoundaryBC object.
 
-## Example Input File Syntax
+!! ## Example Input File Syntax
 
 !! Describe and include an example of how to use the PenaltyDisplaceBoundaryBC object.
 

diff --git a/doc/content/source/bcs/RadiationEnergyFluxBC.md b/doc/content/source/bcs/RadiationEnergyFluxBC.md
@@ -1,18 +1,12 @@
 # RadiationEnergyFluxBC
 
-!alert construction title=Undocumented Class
-The RadiationEnergyFluxBC 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 /BCs/RadiationEnergyFluxBC
 
-## Overview
+!! ## Overview
 
 !! Replace these lines with information regarding the RadiationEnergyFluxBC object.
 
-## Example Input File Syntax
+!! ## Example Input File Syntax
 
 !! Describe and include an example of how to use the RadiationEnergyFluxBC object.
 

diff --git a/doc/content/source/bcs/SurfaceTensionBC.md b/doc/content/source/bcs/SurfaceTensionBC.md
@@ -1,18 +1,12 @@
 # SurfaceTensionBC
 
-!alert construction title=Undocumented Class
-The SurfaceTensionBC 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 /BCs/SurfaceTensionBC
 
-## Overview
+!! ## Overview
 
 !! Replace these lines with information regarding the SurfaceTensionBC object.
 
-## Example Input File Syntax
+!! ## Example Input File Syntax
 
 !! Describe and include an example of how to use the SurfaceTensionBC object.
 

diff --git a/doc/content/source/bcs/VaporRecoilPressureMomentumFluxBC.md b/doc/content/source/bcs/VaporRecoilPressureMomentumFluxBC.md
@@ -1,18 +1,12 @@
 # VaporRecoilPressureMomentumFluxBC
 
-!alert construction title=Undocumented Class
-The VaporRecoilPressureMomentumFluxBC 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 /BCs/VaporRecoilPressureMomentumFluxBC
 
-## Overview
+!! ## Overview
 
 !! Replace these lines with information regarding the VaporRecoilPressureMomentumFluxBC object.
 
-## Example Input File Syntax
+!! ## Example Input File Syntax
 
 !! Describe and include an example of how to use the VaporRecoilPressureMomentumFluxBC object.
 

diff --git a/doc/content/source/indicators/AbsoluteValueIndicator.md b/doc/content/source/indicators/AbsoluteValueIndicator.md
@@ -1,18 +1,12 @@
 # AbsoluteValueIndicator
 
-!alert construction title=Undocumented Class
-The AbsoluteValueIndicator 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 /Adaptivity/Indicators/AbsoluteValueIndicator
 
-## Overview
+!! ## Overview
 
 !! Replace these lines with information regarding the AbsoluteValueIndicator object.
 
-## Example Input File Syntax
+!! ## Example Input File Syntax
 
 !! Describe and include an example of how to use the AbsoluteValueIndicator object.
 

diff --git a/doc/content/source/kernels/ADStressDivergence.md b/doc/content/source/kernels/ADStressDivergence.md
@@ -1,18 +1,12 @@
 # ADStressDivergence
 
-!alert construction title=Undocumented Class
-The ADStressDivergence 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 /Kernels/ADStressDivergence
 
-## Overview
+!! ## Overview
 
 !! Replace these lines with information regarding the ADStressDivergence object.
 
-## Example Input File Syntax
+!! ## Example Input File Syntax
 
 !! Describe and include an example of how to use the ADStressDivergence object.
 

diff --git a/doc/content/source/kernels/BaldrConvectedMesh.md b/doc/content/source/kernels/BaldrConvectedMesh.md
@@ -1,18 +1,12 @@
 # BaldrConvectedMesh
 
-!alert construction title=Undocumented Class
-The BaldrConvectedMesh 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 /Kernels/BaldrConvectedMesh
 
-## Overview
+!! ## Overview
 
 !! Replace these lines with information regarding the BaldrConvectedMesh object.
 
-## Example Input File Syntax
+!! ## Example Input File Syntax
 
 !! Describe and include an example of how to use the BaldrConvectedMesh object.
 

diff --git a/doc/content/source/kernels/BaldrTemperatureConvectedMesh.md b/doc/content/source/kernels/BaldrTemperatureConvectedMesh.md
@@ -1,18 +1,12 @@
 # BaldrTemperatureConvectedMesh
 
-!alert construction title=Undocumented Class
-The BaldrTemperatureConvectedMesh 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 /Kernels/BaldrTemperatureConvectedMesh
 
-## Overview
+!! ## Overview
 
 !! Replace these lines with information regarding the BaldrTemperatureConvectedMesh object.
 
-## Example Input File Syntax
+!! ## Example Input File Syntax
 
 !! Describe and include an example of how to use the BaldrTemperatureConvectedMesh object.
 

diff --git a/doc/content/source/materials/CrazyKCPlantFits.md b/doc/content/source/materials/CrazyKCPlantFits.md
@@ -1,18 +1,12 @@
 # CrazyKCPlantFits
 
-!alert construction title=Undocumented Class
-The CrazyKCPlantFits 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 /Materials/CrazyKCPlantFits
 
-## Overview
+!! ## Overview
 
 !! Replace these lines with information regarding the CrazyKCPlantFits object.
 
-## Example Input File Syntax
+!! ## Example Input File Syntax
 
 !! Describe and include an example of how to use the CrazyKCPlantFits object.
 

diff --git a/doc/content/source/materials/CrazyKCPlantFitsBoundary.md b/doc/content/source/materials/CrazyKCPlantFitsBoundary.md
@@ -1,18 +1,12 @@
 # CrazyKCPlantFitsBoundary
 
-!alert construction title=Undocumented Class
-The CrazyKCPlantFitsBoundary 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 /Materials/CrazyKCPlantFitsBoundary
 
-## Overview
+!! ## Overview
 
 !! Replace these lines with information regarding the CrazyKCPlantFitsBoundary object.
 
-## Example Input File Syntax
+!! ## Example Input File Syntax
 
 !! Describe and include an example of how to use the CrazyKCPlantFitsBoundary object.
 

diff --git a/doc/content/source/materials/PseudoSolidStress.md b/doc/content/source/materials/PseudoSolidStress.md
@@ -1,18 +1,12 @@
 # PseudoSolidStress
 
-!alert construction title=Undocumented Class
-The PseudoSolidStress 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 /Materials/PseudoSolidStress
 
-## Overview
+!! ## Overview
 
 !! Replace these lines with information regarding the PseudoSolidStress object.
 
-## Example Input File Syntax
+!! ## Example Input File Syntax
 
 !! Describe and include an example of how to use the PseudoSolidStress object.