Skip to content

Commit 15196c5

Browse files
committed
DOC: Replace /** with // in hxx file of RecursiveGaussianImageFilter
`/**` comments are specifically meant for doxygen, so they should only appear in "*.h" files.
1 parent 918b181 commit 15196c5

File tree

1 file changed

+15
-21
lines changed

1 file changed

+15
-21
lines changed

Modules/Filtering/Smoothing/include/itkRecursiveGaussianImageFilter.hxx

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -24,39 +24,34 @@
2424

2525
namespace itk
2626
{
27-
/**
28-
* Explicitly set a zeroth order derivative.
29-
*/
27+
// Explicitly set a zeroth order derivative.
3028
template <typename TInputImage, typename TOutputImage>
3129
void
3230
RecursiveGaussianImageFilter<TInputImage, TOutputImage>::SetZeroOrder()
3331
{
3432
this->SetOrder(GaussianOrderEnum::ZeroOrder);
3533
}
3634

37-
/**
38-
* Explicitly set a first order derivative.
39-
*/
35+
36+
// Explicitly set a first order derivative.
4037
template <typename TInputImage, typename TOutputImage>
4138
void
4239
RecursiveGaussianImageFilter<TInputImage, TOutputImage>::SetFirstOrder()
4340
{
4441
this->SetOrder(GaussianOrderEnum::FirstOrder);
4542
}
4643

47-
/**
48-
* Explicitly set a second order derivative.
49-
*/
44+
45+
// Explicitly set a second order derivative.
5046
template <typename TInputImage, typename TOutputImage>
5147
void
5248
RecursiveGaussianImageFilter<TInputImage, TOutputImage>::SetSecondOrder()
5349
{
5450
this->SetOrder(GaussianOrderEnum::SecondOrder);
5551
}
5652

57-
/**
58-
* Compute filter for Gaussian kernel.
59-
*/
53+
54+
// Compute filter for Gaussian kernel.
6055
template <typename TInputImage, typename TOutputImage>
6156
void
6257
RecursiveGaussianImageFilter<TInputImage, TOutputImage>::SetUp(ScalarRealType spacing)
@@ -192,9 +187,8 @@ RecursiveGaussianImageFilter<TInputImage, TOutputImage>::SetUp(ScalarRealType sp
192187
}
193188
}
194189

195-
/**
196-
* Compute the N coefficients.
197-
*/
190+
191+
// Compute the N coefficients.
198192
template <typename TInputImage, typename TOutputImage>
199193
void
200194
RecursiveGaussianImageFilter<TInputImage, TOutputImage>::ComputeNCoefficients(ScalarRealType sigmad,
@@ -236,9 +230,8 @@ RecursiveGaussianImageFilter<TInputImage, TOutputImage>::ComputeNCoefficients(Sc
236230
EN = N1 + 4 * N2 + 9 * N3;
237231
}
238232

239-
/**
240-
* Compute the D coefficients.
241-
*/
233+
234+
// Compute the D coefficients.
242235
template <typename TInputImage, typename TOutputImage>
243236
void
244237
RecursiveGaussianImageFilter<TInputImage, TOutputImage>::ComputeDCoefficients(ScalarRealType sigmad,
@@ -269,9 +262,8 @@ RecursiveGaussianImageFilter<TInputImage, TOutputImage>::ComputeDCoefficients(Sc
269262
ED = this->m_D1 + 4 * this->m_D2 + 9 * this->m_D3 + 16 * this->m_D4;
270263
}
271264

272-
/**
273-
* Compute the M coefficients and the boundary coefficients.
274-
*/
265+
266+
// Compute the M coefficients and the boundary coefficients.
275267
template <typename TInputImage, typename TOutputImage>
276268
void
277269
RecursiveGaussianImageFilter<TInputImage, TOutputImage>::ComputeRemainingCoefficients(bool symmetric)
@@ -308,6 +300,7 @@ RecursiveGaussianImageFilter<TInputImage, TOutputImage>::ComputeRemainingCoeffic
308300
this->m_BM4 = this->m_D4 * SM / SD;
309301
}
310302

303+
311304
template <typename TInputImage, typename TOutputImage>
312305
void
313306
RecursiveGaussianImageFilter<TInputImage, TOutputImage>::VerifyPreconditions() const
@@ -320,6 +313,7 @@ RecursiveGaussianImageFilter<TInputImage, TOutputImage>::VerifyPreconditions() c
320313
}
321314
}
322315

316+
323317
template <typename TInputImage, typename TOutputImage>
324318
void
325319
RecursiveGaussianImageFilter<TInputImage, TOutputImage>::PrintSelf(std::ostream & os, Indent indent) const

0 commit comments

Comments
 (0)