SyneRBI / SIRF

Main repository for the CCP SynerBI software
http://www.ccpsynerbi.ac.uk
Other
59 stars 29 forks source link

doxygen warnings #1081

Open KrisThielemans opened 2 years ago

KrisThielemans commented 2 years ago

After stripping warnings about undocumented members, I still get

.../src/Registration/NiftyMoMo/include/sirf/NiftyMoMo/BSplineTransformation.h:86: warning: argument 'sourceImage' of command @param is not found in the argument list of NiftyMoMo::BSplineTransformation::GetDVFGradientWRTTransformationParameters(nifti_image *denseDVFIn)
.../src/Registration/NiftyMoMo/include/sirf/NiftyMoMo/BSplineTransformation.h:75: warning: argument 'paramsIn' of command @param is not found in the argument list of NiftyMoMo::BSplineTransformation::SetParameters(BSplineTransformation::PrecisionType *parametersIn, bool parametersAreDisplacements)
  parameter 'parametersIn'
.../src/Registration/NiftyMoMo/include/sirf/NiftyMoMo/Transformation.h:59: warning: argument 'referenceImageIn' of command @param is not found in the argument list of NiftyMoMo::Transformation::InitialiseLevel(unsigned int level)=0
  parameter 'level'
.../src/xGadgetron/cGadgetron/include/sirf/Gadgetron/TrajectoryPreparation.h:218: warning: explicit link request to 'Angles' could not be resolved
.../src/xSTIR/cSTIR/include/sirf/STIR/stir_x.h:487: warning: argument 'linear' of command @param is not found in the argument list of sirf::PETAcquisitionModel::forward(PETAcquisitionData &acq_data, const STIRImageData &image, int subset_num, int num_subsets, bool zero=false, bool do_linear_only=false) const
  parameter 'do_linear_only'
.../src/xGadgetron/cGadgetron/include/sirf/Gadgetron/TrajectoryPreparation.h:218: warning: explicit link request to 'Angles' could not be resolved

I suggest we ignore those in NiftyMoMo as we need to replace these files with their new repo anyway.

KrisThielemans commented 2 years ago

Feel free to postpone to 3.3