Page MenuHomeHEPForge

Initial setup for Doxygen generation
ClosedPublic

Authored by tlatham on Feb 17 2021, 7:29 PM.

Details

Summary

Create necessary CMake configuration to automate generation of Doxygen documentation

Test Plan

Enabled generation of Doxygen with -DEVTGEN_BUILD_DOXYGEN=ON
Verified Doxygen pages were successfully generated

Diff Detail

Repository
rEVTGEN evtgen
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

tlatham changed the visibility from "All Users" to "Public (No Login Required)".Feb 17 2021, 7:32 PM
tlatham changed the edit policy from "All Users" to "Restricted Project (Project)".
tlatham added a project: Restricted Project.

I've copied what is currently generated from this to the following page so that you can look at it more easily:
https://evtgen.hepforge.org/doc/doxygen/test/

I've spotted one small issue that I'll try and fix: the full path to the files on my local system is quoted at the bottom of the pages rather than their relative path within the repository.

We should probably also reformat the README, AUTHORS, and History.txt files to be more compatible with Markdown format, then they'll display rather better within the Doxygen pages.

  • Start to convert various files to Markdown format

It all looks good to me. I note that you have shuffled things in README a little bit and it makes sense, but we will need to write a few words in the introduction. Perhaps we can adapt things from the introduction of the guide, but I would be happy to land this and add an introduction in README in another step.

This revision is now accepted and ready to land.Mar 10 2021, 10:55 AM

Thanks @kreps , yes the README needs some text in the introduction but agree we can maybe add that in a separate step.
However, I also need to finish going through the History file and making it looks reasonable in Markdown format and would maybe prefer to do the latter before landing - let me see if I can do it today.

  • Start to convert various files to Markdown format
  • Start to convert various files to Markdown format

Thanks @kreps , yes the README needs some text in the introduction but agree we can maybe add that in a separate step.
I've just finished going through the History file and making it looks reasonable in Markdown format, see:
https://evtgen.hepforge.org/doc/doxygen/test/md_History.html
So I think this can indeed be landed now.

This revision was automatically updated to reflect the committed changes.