Project

General

Profile

Bug #24928

Time scale documentation moved

Added by Gianluca Petrillo about 2 months ago. Updated 29 days ago.

Status:
Closed
Priority:
Normal
Category:
Documentation
Target version:
-
Start date:
09/08/2020
Due date:
% Done:

100%

Estimated time:
Occurs In:
Experiment:
-
Co-Assignees:
Duration:

Description

The Doxygen documentation of time scales has ended up in DetectorClocksData.h file, in a way that links it to detinfo namespace, which is not appropriate.
It used to be associated with detinfo::DetectorClocks object.
I recommend one of two solutions:

1. move it back to detinfo::DetectorClocks class
2. associate it to detinfo::DetectorClocksData class, and add a reference to it where the documentation used to be in detinfo::DetectorClocks (something like: The definitions of time scales are documented in `detinfo::DetectorClocksData` class.)

History

#1 Updated by Kyle Knoepfel about 1 month ago

  • Assignee set to Gianluca Petrillo
  • Status changed from New to Assigned

Sorry for this error, Gianluca. Do you mind making the correction according to your preferred fix?

#2 Updated by Gianluca Petrillo about 1 month ago

Ok.
Being busy and forgetful now: please ping me by the next triage (next Monday?) if there will have been no pull request from me yet.
(am I using tenses creatively?)

#3 Updated by Gianluca Petrillo about 1 month ago

  • % Done changed from 0 to 100

I have moved the documentation to detinfo::DetectorClocksData and added some relevant missing information.
I also updated some documentation that became outdated after v9 changes.

I am not equipped to test the Doxygen rendering of the result.

Pull request is lardataalg #11.

#4 Updated by Kyle Knoepfel about 1 month ago

  • Status changed from Assigned to Resolved

PR is included in LArSoft v09_03_00.

#5 Updated by Kyle Knoepfel 29 days ago

  • Status changed from Resolved to Closed


Also available in: Atom PDF