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

clarify documentation for CartesianFields #140

Merged
merged 2 commits into from Mar 31, 2017

Conversation

Projects
None yet
2 participants
@gaede
Contributor

gaede commented Mar 30, 2017

BEGINRELEASENOTES

  • clarify documentation for CartesianField and implementations
  • make clear that void fieldComponents() has to add
    the new field to the given field vector
    ENDRELEASENOTES
clarify documentation for CartesianFields
 - make clear that  void fieldComponents() has to add
   the new field to the given field vector

@gaede gaede requested a review from MarkusFrankATcernch Mar 31, 2017

@MarkusFrankATcernch

This comment has been minimized.

Contributor

MarkusFrankATcernch commented Mar 31, 2017

All fine with me. But the doxygen format looks wrong:
I Think it MUST be like this:

/// Handle class describing any field with 3D cartesian vectors for the field strength.
/** More blabla

The first line is the short description, which doxygen puts into the
class list....

@gaede

This comment has been minimized.

Contributor

gaede commented Mar 31, 2017

Added requested change - will merge

@gaede gaede merged commit 3497400 into AIDASoft:master Mar 31, 2017

1 check was pending

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
@MarkusFrankATcernch

This comment has been minimized.

Contributor

MarkusFrankATcernch commented Mar 31, 2017

Just for the sake of it:
Whenever you get hold of a header, which does not have this one line explanation,
please add it. And, of course remove the Id$ fields ....

Thank you!

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