Project

General

Profile

Support #22326

Revise misleading documentation in MetricPlugin.hh

Added by Eric Flumerfelt 7 months ago. Updated 7 months ago.

Status:
Resolved
Priority:
Normal
Category:
-
Target version:
-
Start date:
04/08/2019
Due date:
% Done:

0%

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

Description

The "level" parameter of MetricPlugin has misleading Doxygen documentation. Interestingly enough, the FHiCL parameter declaration has much better documentation.

Currently, the Doxygen documentation reads:

The verbosity level of the metric plugin. Higher number = fewer metrics sent to the metric storage

I am going to replace this with the following, which is used as the fhicl::Comment for that parameter:

The verbosity level threshold for this plugin. sendMetric calls with verbosity level greater than this will not be sent to the plugin.

History

#1 Updated by Eric Flumerfelt 7 months ago

  • Status changed from Work in progress to Resolved

Implemented on artdaq-utilities:feature/22326_MetricPlugin_FixParameterDocumentation.



Also available in: Atom PDF