[Rivet] Doxygen for plugins

[Andy Buckley]

Hi David,

I changed the Doxygen config to only look at the header files, and also to exclude some internal types defined in them. Since the analyses are just .cc files, they disappeared.

This wasn't just an accident: the point of the API documentation is to tell users about the code interface. Analyses aren't part of the interface -- they all have to behave like the base Analysis class, but any other aspects of their derived interface are purely implementation details and ~no-one should care. Those who do can look at the code directly, and "metadata" about them is available via the (now more convenient) analysis documentation.

Why do you need access to the analysis Doxygen? We could make a second Doxygen build for that purpose, but since it would be yet more work/complexity as part of the release process there would need to be a very good reason... and I don't currently see what that would be.

Andy
Dr Andy Buckley, Lecturer / Royal Society University Research Fellow
Particle Physics Experiment Group, University of Glasgow

On Jan 6 2018, at 12:11 pm, David Yallup <david.yallup at cern.ch> wrote:
> Dear Rivet authors,
>
> This might be me being dense but I can't find the source code in doxygen
> for the analysis plugins on the hepforge site any more? I used to just
> go here
>
> https://rivet.hepforge.org/code/dev/files.html
>
> But I can't seem to find them, have they been moved/gone missing?
>
> Cheers,
>
> David
>
> _______________________________________________
> Rivet mailing list
> Rivet at projects.hepforge.org
> https://www.hepforge.org/lists/listinfo/rivet
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://www.hepforge.org/lists-archive/rivet/attachments/20180107/d109e0bb/attachment.html>