Skip to content

Documentation #22

@simonepigazzini

Description

@simonepigazzini

I started a "serious" documentation effort. The main goal is to describe the branches of the reco trees as well as the options of the configuration file. To achieve this I think the easiest is to have a docstring parsed by doxygen (and eventually redered by sphinx):

  • in the .h of each output trees describing the variable corresponding to the branch (In case the names do not match one to one the actual branch name should be specified in the docstring)
  • In the .h of each plugin describe the options as part of the class docstring.

This would leave out some global option that can we place in the docstring of the main executable probably.

I've started with the digi tree: https://h4analysis.web.cern.ch/#_CPPv48DigiTree

@thomreis @camendola can you please help out with this? @thomreis mainly for the spike part.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions