[Rivet] Doxygen for plugins

[Frank Siegert]

That's pretty cool, thanks!

Frank


On 8 January 2018 at 11:43, Andy Buckley <andy.buckley at cern.ch> wrote:

> You're lucky I've got a deadline to procrastinate for: it's done ;-)
>
> See e.g. https://rivet.hepforge.org/analyses/ATLAS_2017_I1632756.html
>
> Andy
>
> *Dr Andy Buckley, Lecturer / Royal Society University Research Fellow*
> Particle Physics Experiment Group, University of Glasgow
>
> On Jan 8 2018, at 10:12 am, Christian Gutschow <chris.g at cern.ch> wrote:
>
>> Yes please, that would be great! :-)
>>
>> Cheers,
>> Chris
>>
>> On 8 Jan 2018, at 10:04, Andy Buckley <andy.buckley at cern.ch> wrote:
>>
>> You show the generated Doxygen, or you use Doxygen's formatting of the
>> .cc source? That's also possible through the hg interface, e.g.
>> https://rivet.hepforge.org/hg/rivet/file/tip  But I admit that the URLs
>> are awkward, and there's no syntax highlighting.
>>
>> Here's a possibility: we add syntax-highlighted source code to the
>> analysis metadata pages, now that that's not on one huge HTML page. Would
>> that do what you need? It would have the benefits of keeping the API docs
>> clean (although still very much improveable...) and of not adding any more
>> steps to the release procedure.
>>
>> Andy
>>
>> *Dr Andy Buckley, Lecturer / Royal Society University Research Fellow*
>> Particle Physics Experiment Group, University of Glasgow
>>
>> On Jan 8 2018, at 9:39 am, Christian Gutschow <chris.g at cern.ch> wrote:
>>
>> Hi,
>>
>> 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.
>>
>>
>> True for the projections, but I reckon that if you’re new to Rivet (and
>> possibly beyond), it is more instructive/convenient to browse through the
>> existing experimental analysis cc files in a web browser in order to
>> understand how the projections are being used, no?
>>
>> I’m certainly guilty of advertising in tutorials and what not a wealth of
>> example code from existing analyses on the web...
>>
>> Cheers,
>> Chris
>>
>>
>>
>> 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
>>
>> _______________________________________________
>> Rivet mailing list
>> Rivet at projects.hepforge.org
>> https://www.hepforge.org/lists/listinfo/rivet
>>
>>
>>
>>
>>
>>  —
>>
>>  Dr. Christian Gütschow
>>
>>  Department of Physics and Astronomy
>>  University College London
>>  Gower Street
>>  London WC1E 6BT
>>
>>
>>
>>
>>
>>
>>
>>  —
>>
>>  Dr. Christian Gütschow
>>
>>  Department of Physics and Astronomy
>>  University College London
>>  Gower Street
>>  London WC1E 6BT
>>
>>
>>
>>
> _______________________________________________
> 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/20180108/677c6097/attachment.html>