Project

General

Profile

Support #6337

Document API using a tool such as Doxygen

Added by Ben Morgan over 5 years ago. Updated about 2 years ago.

Status:
Feedback
Priority:
Normal
Assignee:
-
Target version:
-
Start date:
05/23/2014
Due date:
% Done:

0%

Estimated time:
Duration:

Description

Though the wiki page provides some hints, it would be useful to have the API of fhicl-cpp documented.

This could use a suitable markup tool such as Doxygen.


Related issues

Related to cetlib - Support #6334: Document API using a tool such as DoxygenFeedback05/23/2014

Related to messagefacility - Support #6338: Document Message Facility API using a tool such as DoxygenFeedback05/23/2014

History

#1 Updated by Christopher Green over 5 years ago

  • Tracker changed from Feature to Support
  • Status changed from New to Feedback

We would like to discuss this at the stakeholders meeting, since this does entail a significant amount of effort from the point of view of both the tool choice and configuration for automatic use, and the documentation of the APIs in the chosen format. Please note that we do have the ongoing art workbook project, where you may find some of the information you seek.

#2 Updated by Kyle Knoepfel over 4 years ago

  • Target version set to 521

#3 Updated by Kyle Knoepfel about 2 years ago

  • Target version deleted (521)


Also available in: Atom PDF