InsightSoftwareConsortium / InsightSoftwareConsortium/ITK

Improve class documentation

Open
#6,348 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
1.7k
Forks
748
Avg merge
1d 1h
Merged PRs (30d)
64

Description

Whenever a paper is mentioned, including the corresponding reference (i.e. full bibliography cite and/or link) would be nice.
See for example, the block
` * \brief Wavelet based on paper VOW: Variance-Optimal Wavelets for Steerable Pyramid (P.Pad et al 2014).
`
in `itkVowIsotropicWavelet.h`.

On the other hand, formulas must follow Doxygen rules [1]. There are a few examples in ITK, such as [2].

[1] http://www.stack.nl/~dimitri/doxygen/manual/formulas.html
[2] https://github.com/InsightSoftwareConsortium/ITK/blob/master/Modules/Filtering/ImageNoise/include/itkShotNoiseImageFilter.h

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.