Page MenuHomeHEPForge

Initial setup for Doxygen generation
Needs ReviewPublic

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

Details

Reviewers
jback
kreps
Maniphest Tasks
T98: Doxygenate the code
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
Branch
doxygen_cmake_config
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 154
Build 154: arc lint + arc unit

Event Timeline

tlatham created this revision.Wed, Feb 17, 7:29 PM
tlatham changed the visibility from "All Users" to "Public (No Login Required)".Wed, Feb 17, 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.

tlatham updated this revision to Diff 222.Thu, Feb 18, 2:43 PM
  • Fix stripping of paths
tlatham updated this revision to Diff 227.Tue, Mar 2, 12:03 AM
  • Start to convert various files to Markdown format