Skip to content

Commit

Permalink
Merge pull request #15971 from aeslaughter/sqa-15968
Browse files Browse the repository at this point in the history
Remove all empty 'issues' and complete class descriptions for framework
  • Loading branch information
aeslaughter authored Nov 5, 2020
2 parents 1b20f62 + 6492363 commit 56c8c77
Show file tree
Hide file tree
Showing 271 changed files with 433 additions and 1,023 deletions.

This file was deleted.

217 changes: 0 additions & 217 deletions framework/doc/hidden.yml

This file was deleted.

1 change: 0 additions & 1 deletion framework/include/userobject/ElementIntegralUserObject.h
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,3 @@ class ElementIntegralUserObject : public ElementUserObject

Real _integral_value;
};

3 changes: 1 addition & 2 deletions framework/include/userobject/LayeredSideAverage.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ InputParameters validParams<LayeredSideAverage>();

/**
* This UserObject computes side averages of a variable storing partial sums for the specified
* number of intervals in a direction (x,y,z).c
* number of intervals in a direction (x,y,z).
*/
class LayeredSideAverage : public LayeredSideIntegral
{
Expand All @@ -38,4 +38,3 @@ class LayeredSideAverage : public LayeredSideIntegral
/// Value of the volume for each layer
std::vector<Real> _layer_volumes;
};

2 changes: 2 additions & 0 deletions framework/src/actions/AdaptivityAction.C
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ InputParameters
AdaptivityAction::validParams()
{
InputParameters params = Action::validParams();
params.addClassDescription(
"Add libMesh based adaptation schemes via the Executioner/Adaptivity input syntax.");
MooseEnum estimators("KellyErrorEstimator LaplacianErrorEstimator PatchRecoveryErrorEstimator",
"KellyErrorEstimator");

Expand Down
4 changes: 3 additions & 1 deletion framework/src/actions/AddAuxVariableAction.C
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ defineLegacyParams(AddAuxVariableAction);
InputParameters
AddAuxVariableAction::validParams()
{
return AddVariableAction::validParams();
InputParameters params = AddVariableAction::validParams();
params.addClassDescription("Add auxiliary variable to the simulation.");
return params;
}

AddAuxVariableAction::AddAuxVariableAction(InputParameters params) : AddVariableAction(params) {}
Expand Down
1 change: 1 addition & 0 deletions framework/src/actions/AddBCAction.C
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ AddBCAction::validParams()
{
InputParameters params = MooseObjectAction::validParams();
params += BoundaryCondition::validParams();
params.addClassDescription("Add a BoundaryCondition object to the simulation.");
return params;
}

Expand Down
5 changes: 4 additions & 1 deletion framework/src/actions/AddBoundsVectorsAction.C
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@ defineLegacyParams(AddBoundsVectorsAction);
InputParameters
AddBoundsVectorsAction::validParams()
{
return Action::validParams();
InputParameters params = Action::validParams();
params.addClassDescription(
"Action to add vectors to nonlinear system when using the Bounds syntax.");
return params;
}

AddBoundsVectorsAction::AddBoundsVectorsAction(InputParameters params) : Action(params) {}
Expand Down
4 changes: 3 additions & 1 deletion framework/src/actions/AddConstraintAction.C
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ defineLegacyParams(AddConstraintAction);
InputParameters
AddConstraintAction::validParams()
{
return MooseObjectAction::validParams();
InputParameters params = MooseObjectAction::validParams();
params.addClassDescription("Add a Constraint object to the simulation.");
return params;
}

AddConstraintAction::AddConstraintAction(InputParameters params) : MooseObjectAction(params) {}
Expand Down
1 change: 1 addition & 0 deletions framework/src/actions/AddControlAction.C
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ InputParameters
AddControlAction::validParams()
{
InputParameters params = MooseObjectAction::validParams();
params.addClassDescription("Add a Control object to the simulation.");
return params;
}

Expand Down
4 changes: 3 additions & 1 deletion framework/src/actions/AddDGKernelAction.C
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ defineLegacyParams(AddDGKernelAction);
InputParameters
AddDGKernelAction::validParams()
{
return MooseObjectAction::validParams();
InputParameters params = MooseObjectAction::validParams();
params.addClassDescription("Add a DGKernel object to the simulation.");
return params;
}

AddDGKernelAction::AddDGKernelAction(InputParameters params) : MooseObjectAction(params) {}
Expand Down
4 changes: 3 additions & 1 deletion framework/src/actions/AddDamperAction.C
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ defineLegacyParams(AddDamperAction);
InputParameters
AddDamperAction::validParams()
{
return MooseObjectAction::validParams();
InputParameters params = MooseObjectAction::validParams();
params.addClassDescription("Add a Damper object to the simulation.");
return params;
}

AddDamperAction::AddDamperAction(InputParameters params) : MooseObjectAction(params) {}
Expand Down
1 change: 1 addition & 0 deletions framework/src/actions/AddDiracKernelAction.C
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ InputParameters
AddDiracKernelAction::validParams()
{
InputParameters params = MooseObjectAction::validParams();
params.addClassDescription("Add a DiracKernel object to the simulation.");
return params;
}

Expand Down
4 changes: 3 additions & 1 deletion framework/src/actions/AddDistributionAction.C
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ defineLegacyParams(AddDistributionAction);
InputParameters
AddDistributionAction::validParams()
{
return MooseObjectAction::validParams();
InputParameters params = MooseObjectAction::validParams();
params.addClassDescription("Add a Distribution object to the simulation.");
return params;
}

AddDistributionAction::AddDistributionAction(InputParameters params) : MooseObjectAction(params) {}
Expand Down
4 changes: 3 additions & 1 deletion framework/src/actions/AddFVBCAction.C
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ registerMooseAction("MooseApp", AddFVBCAction, "add_fv_bc");
InputParameters
AddFVBCAction::validParams()
{
return MooseObjectAction::validParams();
InputParameters params = MooseObjectAction::validParams();
params.addClassDescription("Add a FVBoundaryCondition object to the simulation.");
return params;
}

AddFVBCAction::AddFVBCAction(InputParameters params) : MooseObjectAction(params) {}
Expand Down
4 changes: 3 additions & 1 deletion framework/src/actions/AddFVKernelAction.C
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ registerMooseAction("MooseApp", AddFVKernelAction, "add_fv_kernel");
InputParameters
AddFVKernelAction::validParams()
{
return MooseObjectAction::validParams();
InputParameters params = MooseObjectAction::validParams();
params.addClassDescription("Add a FVKernel object to the simulation.");
return params;
}

AddFVKernelAction::AddFVKernelAction(InputParameters params) : MooseObjectAction(params) {}
Expand Down
Loading

0 comments on commit 56c8c77

Please sign in to comment.