Initial setup for Doxygen generation
Needs ReviewPublic
Actions

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 155
Build 155: arc lint + arc unit

Event Timeline

tlatham created this revision.Wed, Feb 17, 7:29 PM

Harbormaster completed remote builds in B154: Diff 215.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.

tlatham added a task: T98: Doxygenate the code.

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.

Fix stripping of paths

Harbormaster completed remote builds in B155: Diff 222.Thu, Feb 18, 2:43 PM

Start to convert various files to Markdown format

Harbormaster completed remote builds in B160: Diff 227.Tue, Mar 2, 12:03 AM

Revision Contents
Changeset List

		Path
M		CMakeLists.txt (33 lines)
A	M	doxygen/CMakeLists.txt (68 lines)
A	M	doxygen/Doxyfile.in (2435 lines)
A	M	doxygen/mainpage.dox.in (42 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	215	d8d1db8		Wed, Feb 17, 7:29 PM	★	★
Diff 2	222	d8d1db8	- Fix stripping of paths	Thu, Feb 18, 2:43 PM	★	★
Diff 3	227	d8d1db8	- Start to convert various files to Markdown format	Tue, Mar 2, 12:03 AM	★	★

Commit	Tree	Parents	Author	Summary	Date
f54ab150d25e	cbab8a706496	99c6343607c5	Thomas Latham	Fix stripping of paths	Thu, Feb 18, 2:43 PM
99c6343607c5	84cde003a0d4	d8d1db88af38	Thomas Latham	Initial setup for Doxygen generation (Show More…)	Wed, Feb 17, 7:24 PM