Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve class documentation #15

Open
jhlegarreta opened this issue Feb 18, 2017 · 1 comment
Open

Improve class documentation #15

jhlegarreta opened this issue Feb 18, 2017 · 1 comment

Comments

@jhlegarreta
Copy link
Member

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

@phcerdan
Copy link
Collaborator

I have fixed the latex issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants