Commit c6bdab0e authored by Simon Spannagel's avatar Simon Spannagel
Browse files

Add Doxygen reference

parent 7cae06ef
#############################################
# Doxygen target to generate API reference #
#############################################
FIND_PACKAGE(Doxygen)
IF(DOXYGEN_FOUND)
CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/doc/reference/Doxyfile.in ${CMAKE_BINARY_DIR}/reference/Doxyfile @ONLY)
ADD_CUSTOM_TARGET(reference
${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/reference/Doxyfile
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/reference
COMMENT "Generating API documentation with Doxygen"
VERBATIM
)
ENDIF(DOXYGEN_FOUND)
###############################################
# LaTeX target to compile the PDF user manual #
###############################################
......
This diff is collapsed.
<div style="max-width: 1000px; margin-bottom: 10px">
Welcome to the Doxygen code reference of Corryvreckan. This is not an introduction to Corryvreckan, for this please refer to the user manual.
</div>
<div style="max-width: 1000px; margin-bottom: 10px">
This documentation describes the all the classes and functions that are part of the framework. It is automatically generated from the source code and is kept up to date with the latest changes to the software. The corresponding version where this reference belongs to is shown in the page header.
</div>
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
<!--BEGIN GENERATE_TREEVIEW-->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
$navpath
<li class="footer">$generatedby
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
</ul>
</div>
<!--END GENERATE_TREEVIEW-->
<!--BEGIN !GENERATE_TREEVIEW-->
<hr class="footer"/><address class="footer"><small>
$generatedby &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
</a> $doxygenversion
</small></address>
<!--END !GENERATE_TREEVIEW-->
</body>
</html>
<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen $doxygenversion"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<link rel="icon" type="image/png" sizes="16x16" href="$relpath^favicon.png">
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="$relpath^jquery.js"></script>
<script type="text/javascript" src="$relpath^dynsections.js"></script>
$treeview
$search
$mathjax
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
$extrastylesheet
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!--BEGIN TITLEAREA-->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<!--BEGIN PROJECT_LOGO-->
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
<!--END PROJECT_LOGO-->
<!--BEGIN PROJECT_NAME-->
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">$projectname
<!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
</div>
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
</td>
<!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME-->
<!--BEGIN PROJECT_BRIEF-->
<td style="padding-left: 0.5em;">
<div id="projectbrief">$projectbrief</div>
</td>
<!--END PROJECT_BRIEF-->
<!--END !PROJECT_NAME-->
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN SEARCHENGINE-->
<td>$searchbox</td>
<!--END SEARCHENGINE-->
<!--END DISABLE_INDEX-->
</tr>
</tbody>
</table>
</div>
<!--END TITLEAREA-->
<!-- end header part -->
This diff is collapsed.
......@@ -16,6 +16,8 @@
#include "objects/Track.h"
namespace corryvreckan {
/** @ingroup Algorithms
*/
class ATLASpixEventLoader : public Algorithm {
public:
......
......@@ -14,6 +14,9 @@
#include "objects/Track.h"
namespace corryvreckan {
/** @ingroup Algorithms
*/
class Alignment : public Algorithm {
public:
......
......@@ -11,6 +11,8 @@
#include "objects/Track.h"
namespace corryvreckan {
/** @ingroup Algorithms
*/
class BasicTracking : public Algorithm {
public:
......
......@@ -15,6 +15,8 @@
#include "objects/Track.h"
namespace corryvreckan {
/** @ingroup Algorithms
*/
class CLICpixEventLoader : public Algorithm {
public:
......
......@@ -11,6 +11,8 @@
#include "objects/Track.h"
namespace corryvreckan {
/** @ingroup Algorithms
*/
class Clicpix2Correlator : public Algorithm {
public:
......
......@@ -16,6 +16,8 @@
#include "objects/Track.h"
namespace corryvreckan {
/** @ingroup Algorithms
*/
class Clicpix2EventLoader : public Algorithm {
public:
......
......@@ -9,6 +9,8 @@
#include "core/algorithm/Algorithm.h"
namespace corryvreckan {
/** @ingroup Algorithms
*/
class ClicpixAnalysis : public Algorithm {
public:
......
......@@ -8,6 +8,8 @@
#include "core/algorithm/Algorithm.h"
namespace corryvreckan {
/** @ingroup Algorithms
*/
class DUTAnalysis : public Algorithm {
public:
......
......@@ -9,6 +9,8 @@
#include "core/algorithm/Algorithm.h"
namespace corryvreckan {
/** @ingroup Algorithms
*/
class DataDump : public Algorithm {
public:
......
......@@ -10,6 +10,8 @@
#include "objects/Track.h"
namespace corryvreckan {
/** @ingroup Algorithms
*/
class DataOutput : public Algorithm {
public:
......
......@@ -15,6 +15,8 @@
#include "objects/Track.h"
namespace corryvreckan {
/** @ingroup Algorithms
*/
class EtaCorrection : public Algorithm {
public:
......
......@@ -7,6 +7,8 @@
#include "core/algorithm/Algorithm.h"
namespace corryvreckan {
/** @ingroup Algorithms
*/
class FileReader : public Algorithm {
public:
......
......@@ -7,6 +7,8 @@
#include "core/algorithm/Algorithm.h"
namespace corryvreckan {
/** @ingroup Algorithms
*/
class FileWriter : public Algorithm {
public:
......
......@@ -14,6 +14,8 @@
#include "objects/Track.h"
namespace corryvreckan {
/** @ingroup Algorithms
*/
class GUI : public Algorithm {
public:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment