Project

General

Profile

Feature #9254

Update Doxygen version to support markdown

Added by Gianluca Petrillo over 5 years ago. Updated almost 5 years ago.

Status:
Closed
Priority:
Low
Assignee:
Lynn Garren
Category:
Documentation
Target version:
-
Start date:
06/19/2015
Due date:
% Done:

100%

Estimated time:
2.00 h
Spent time:
2.00 h
Experiment:
-
Co-Assignees:
Duration:

Description

From version 1.8.0, Doxygen supports a "markdown" type of input.
The documentation written in this mode is easier to read in the source code since it is a bit more visual, and in my opinion is also easier to write in the first place.

I noticed that the version used for LArSoft documentation uses the earlier version 1.7.5.1.
Once Doxygen is updated, markdown is enabled by default.

History

#1 Updated by Lynn Garren over 5 years ago

  • Status changed from New to Accepted
  • Priority changed from Normal to Low

We will need to build and distribute a newer release of doxygen in order to do this.

#2 Updated by Lynn Garren almost 5 years ago

  • Status changed from Accepted to Resolved
  • Assignee set to Lynn Garren
  • % Done changed from 0 to 100
  • Estimated time set to 2.00 h

The doxygen build script runs in ~larsoft/doxygen on one of the gpvm machines. It uses a copy of doxygen that is built in place. I built doxygen 1.8.11 and modified the script to use this release. As of today, the doxygen script is using doxygen 1.8.11.

#3 Updated by Lynn Garren almost 5 years ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF