Skip to content
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

Documentation #22

Open
simonepigazzini opened this issue Oct 25, 2021 · 0 comments
Open

Documentation #22

simonepigazzini opened this issue Oct 25, 2021 · 0 comments
Labels
docs Documentation related help wanted

Comments

@simonepigazzini
Copy link
Owner

simonepigazzini commented Oct 25, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related help wanted
Projects
None yet
Development

No branches or pull requests

1 participant