Ticket #10900 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Clean up doxygen comments in SpaceGroup-related code

Reported by: Michael Wedel Owned by: Michael Wedel
Priority: minor Milestone: Release 3.4
Component: Framework Keywords:
Cc: Blocked By:
Blocking: Tester: Martyn Gigg

Description

After the big clang-format, some doxygen comments with long lines were broken. I would like to fix the ones in MantidGeometry which are related to space groups.

Change History

comment:1 Changed 6 years ago by Michael Wedel

Refs #10900. Updated class- and method documentation in MantidGeometry

Changeset: 39fc02c501d9a7a4fda83df6c81d26787db92bbb

comment:2 Changed 6 years ago by Michael Wedel

  • Status changed from new to verify
  • Resolution set to fixed

This is being verified as ​pull request #124.

comment:3 Changed 6 years ago by Michael Wedel

There is not much to test, just the documentation was updated. The doxygen for the classes that were modified should be free of "accidental lists" and so on.

comment:4 Changed 6 years ago by Martyn Gigg

  • Status changed from verify to verifying
  • Tester set to Martyn Gigg

comment:5 Changed 6 years ago by Martyn Gigg

I built the documentation and I didn't see any errors. I also checked a few classes and the formatting looks okay. Very nice documentation by the way!

comment:6 Changed 6 years ago by Martyn Gigg

  • Status changed from verifying to closed

Merge pull request #124 from mantidproject/feature/10900_cleanup_spacegroups_doxygen

Full changeset: ​bcdd031164c950dc023fd99c3c5941945adb87dd

comment:7 Changed 5 years ago by Nick Draper

Somehow these slipped through without a resolution. Set to Fixed.

comment:8 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​11739

Note: See TracTickets for help on using tickets.