Skip to content

Commit

Permalink
DOC: Remove unnecessary or empty implementation file method doc blocks
Browse files Browse the repository at this point in the history
Remove unnecessary or empty implementation file method documentation
blocks:
- Methods must be documented in header files.
- Overriden methods do not need to be documented unless their
  implementation requires documenting a specific behavior not present in
  the parent's documentation.
  • Loading branch information
jhlegarreta authored and dzenanz committed Dec 28, 2022
1 parent d589e6b commit aff7703
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 63 deletions.
31 changes: 1 addition & 30 deletions Modules/Core/Mesh/include/itkMeshSource.hxx
Expand Up @@ -21,9 +21,7 @@

namespace itk
{
/**
*
*/

template <typename TOutputMesh>
MeshSource<TOutputMesh>::MeshSource()
{
Expand All @@ -38,38 +36,26 @@ MeshSource<TOutputMesh>::MeshSource()
m_GenerateDataNumberOfRegions = 0;
}

/**
*
*/
template <typename TOutputMesh>
typename MeshSource<TOutputMesh>::DataObjectPointer MeshSource<TOutputMesh>::MakeOutput(DataObjectPointerArraySizeType)
{
return TOutputMesh::New().GetPointer();
}

/**
*
*/
template <typename TOutputMesh>
auto
MeshSource<TOutputMesh>::GetOutput() -> OutputMeshType *
{
return itkDynamicCastInDebugMode<TOutputMesh *>(this->GetPrimaryOutput());
}

/**
*
*/
template <typename TOutputMesh>
auto
MeshSource<TOutputMesh>::GetOutput(unsigned int idx) -> OutputMeshType *
{
return itkDynamicCastInDebugMode<TOutputMesh *>(this->ProcessObject::GetOutput(idx));
}

/**
*
*/
template <typename TOutputMesh>
void
MeshSource<TOutputMesh>::SetOutput(OutputMeshType * output)
Expand All @@ -79,29 +65,20 @@ MeshSource<TOutputMesh>::SetOutput(OutputMeshType * output)
this->ProcessObject::SetNthOutput(0, output);
}

/**
*
*/
template <typename TOutputMesh>
void
MeshSource<TOutputMesh>::GenerateInputRequestedRegion()
{
Superclass::GenerateInputRequestedRegion();
}

/**
*
*/
template <typename TOutputMesh>
void
MeshSource<TOutputMesh>::GraftOutput(DataObject * graft)
{
this->GraftNthOutput(0, graft);
}

/**
*
*/
template <typename TOutputMesh>
void
MeshSource<TOutputMesh>::GraftOutput(const DataObjectIdentifierType & key, DataObject * graft)
Expand All @@ -119,9 +96,6 @@ MeshSource<TOutputMesh>::GraftOutput(const DataObjectIdentifierType & key, DataO
output->Graft(graft);
}

/**
*
*/
template <typename TOutputMesh>
void
MeshSource<TOutputMesh>::GraftNthOutput(unsigned int idx, DataObject * graft)
Expand All @@ -134,9 +108,6 @@ MeshSource<TOutputMesh>::GraftNthOutput(unsigned int idx, DataObject * graft)
this->GraftOutput(this->MakeNameFromOutputIndex(idx), graft);
}

/**
*
*/
template <typename TOutputMesh>
void
MeshSource<TOutputMesh>::PrintSelf(std::ostream & os, Indent indent) const
Expand Down
13 changes: 1 addition & 12 deletions Modules/Core/Mesh/include/itkMeshToMeshFilter.hxx
Expand Up @@ -32,19 +32,14 @@

namespace itk
{
/**
*
*/

template <typename TInputMesh, typename TOutputMesh>
MeshToMeshFilter<TInputMesh, TOutputMesh>::MeshToMeshFilter()
{
// Modify superclass default values, can be overridden by subclasses
this->SetNumberOfRequiredInputs(1);
}

/**
*
*/
template <typename TInputMesh, typename TOutputMesh>
void
MeshToMeshFilter<TInputMesh, TOutputMesh>::SetInput(const TInputMesh * input)
Expand All @@ -53,19 +48,13 @@ MeshToMeshFilter<TInputMesh, TOutputMesh>::SetInput(const TInputMesh * input)
this->ProcessObject::SetNthInput(0, const_cast<TInputMesh *>(input));
}

/**
*
*/
template <typename TInputMesh, typename TOutputMesh>
auto
MeshToMeshFilter<TInputMesh, TOutputMesh>::GetInput() const -> const InputMeshType *
{
return itkDynamicCastInDebugMode<const TInputMesh *>(this->GetPrimaryInput());
}

/**
*
*/
template <typename TInputMesh, typename TOutputMesh>
auto
MeshToMeshFilter<TInputMesh, TOutputMesh>::GetInput(unsigned int idx) const -> const InputMeshType *
Expand Down
Expand Up @@ -23,28 +23,20 @@

namespace itk
{
/**
*
*/

template <typename TInputMesh, typename TOutputMesh>
ParametricSpaceToImageSpaceMeshFilter<TInputMesh, TOutputMesh>::ParametricSpaceToImageSpaceMeshFilter()
{
this->SetNumberOfRequiredInputs(1);
}

/**
*
*/
template <typename TInputMesh, typename TOutputMesh>
void
ParametricSpaceToImageSpaceMeshFilter<TInputMesh, TOutputMesh>::PrintSelf(std::ostream & os, Indent indent) const
{
Superclass::PrintSelf(os, indent);
}

/**
* This method causes the filter to generate its output.
*/
template <typename TInputMesh, typename TOutputMesh>
void
ParametricSpaceToImageSpaceMeshFilter<TInputMesh, TOutputMesh>::GenerateData()
Expand Down Expand Up @@ -130,9 +122,6 @@ ParametricSpaceToImageSpaceMeshFilter<TInputMesh, TOutputMesh>::GenerateData()
}
}

/**
* copy information from first input to all outputs
*/
template <typename TInputMesh, typename TOutputMesh>
void
ParametricSpaceToImageSpaceMeshFilter<TInputMesh, TOutputMesh>::GenerateOutputInformation()
Expand Down
Expand Up @@ -22,18 +22,12 @@
namespace itk
{

/**
* Constructor
*/
template <typename TInputPointSet, typename TOutput, typename TCoordRep>
PointSetFunction<TInputPointSet, TOutput, TCoordRep>::PointSetFunction()
{
this->m_PointSet = nullptr;
}

/**
* Standard "PrintSelf" method
*/
template <typename TInputPointSet, typename TOutput, typename TCoordRep>
void
PointSetFunction<TInputPointSet, TOutput, TCoordRep>::PrintSelf(std::ostream & os, Indent indent) const
Expand All @@ -43,9 +37,6 @@ PointSetFunction<TInputPointSet, TOutput, TCoordRep>::PrintSelf(std::ostream & o
itkPrintSelfObjectMacro(PointSet);
}

/**
* Initialize by setting the input point set
*/
template <typename TInputPointSet, typename TOutput, typename TCoordRep>
void
PointSetFunction<TInputPointSet, TOutput, TCoordRep>::SetInputPointSet(const InputPointSetType * ptr)
Expand Down

0 comments on commit aff7703

Please sign in to comment.