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

CPO doxygen warnings #4995

Closed
tjhei opened this issue Nov 1, 2022 · 2 comments
Closed

CPO doxygen warnings #4995

tjhei opened this issue Nov 1, 2022 · 2 comments

Comments

@tjhei
Copy link
Member

tjhei commented Nov 1, 2022

/ssd/aspect-git-clean/include/aspect/particle/property/crystal_preferred_orientation.h:181: warning: argument 'volume_fractions' of command @param is not found in the argument list of aspect::Particle::Property::CrystalPreferredOrientation< dim >::compute_derivatives(const unsigned int cpo_index, const ArrayView< double > &data, const unsigned int mineral_i, const SymmetricTensor< 2, 3 > &strain_rate, const Tensor< 2, 3 > &velocity_gradient_tensor, const std::array< double, 4 > &ref_resolved_shear_stress) const
/ssd/aspect-git-clean/include/aspect/particle/property/crystal_preferred_orientation.h:181: warning: argument 'rotation_matrices' of command @param is not found in the argument list of aspect::Particle::Property::CrystalPreferredOrientation< dim >::compute_derivatives(const unsigned int cpo_index, const ArrayView< double > &data, const unsigned int mineral_i, const SymmetricTensor< 2, 3 > &strain_rate, const Tensor< 2, 3 > &velocity_gradient_tensor, const std::array< double, 4 > &ref_resolved_shear_stress) const
/ssd/aspect-git-clean/include/aspect/particle/property/crystal_preferred_orientation.h:181: warning: argument 'volume_fraction_mineral' of command @param is not found in the argument list of aspect::Particle::Property::CrystalPreferredOrientation< dim >::compute_derivatives(const unsigned int cpo_index, const ArrayView< double > &data, const unsigned int mineral_i, const SymmetricTensor< 2, 3 > &strain_rate, const Tensor< 2, 3 > &velocity_gradient_tensor, const std::array< double, 4 > &ref_resolved_shear_stress) const
/ssd/aspect-git-clean/include/aspect/particle/property/crystal_preferred_orientation.h:193: warning: The following parameters of aspect::Particle::Property::CrystalPreferredOrientation::compute_derivatives(const unsigned int cpo_index, const ArrayView< double > &data, const unsigned int mineral_i, const SymmetricTensor< 2, 3 > &strain_rate, const Tensor< 2, 3 > &velocity_gradient_tensor, const std::array< double, 4 > &ref_resolved_shear_stress) const are not documented:
  parameter 'cpo_index'
  parameter 'data'
  parameter 'mineral_i'
/ssd/aspect-git-clean/include/aspect/particle/property/crystal_preferred_orientation.h:358: warning: The following parameter of aspect::Particle::Property::CrystalPreferredOrientation::set_rotation_matrix_grains(const unsigned int cpo_data_position, const ArrayView< double > &data, const unsigned int mineral_i, const unsigned int grain_i, const Tensor< 2, 3 > rotation_matrix) const is not documented:
  parameter 'rotation_matrix'

@MFraters Can you please take a look?

@MFraters
Copy link
Member

MFraters commented Nov 1, 2022

ah, I see the issue. I will make a pull request to fix it.

@gassmoeller
Copy link
Member

fixed by #4997

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

No branches or pull requests

3 participants