Skip to content

Commit

Permalink
Doxygen index page and menu updates
Browse files Browse the repository at this point in the history
  • Loading branch information
DraTeots committed Aug 8, 2024
1 parent b0f92ab commit 5171df3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/doxygen/doxygen_footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
<script type="text/javascript">
$(document).ready(function() {
let navHeader = '<li><a href="https://github.com/JeffersonLab/JANA2" target="_blank">Project GitHUB</a></li>';
navHeader += '<li><a href="https://JeffersonLab.github.io/JANA2/#/" target="_blank">MAIN DOCUMENTATION</a></li>';
// Append it to the navigation div or another appropriate place in the menu
$('#main-menu').append(navHeader);
});
Expand Down
11 changes: 8 additions & 3 deletions docs/doxygen/doxygen_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
Reference
=========
JANA2 C++ Reference Guide
=========================

This section describes the underlying machinery of JANA. This is essentially a launchpad into Doxygen.
JANA2 is a cutting-edge C++ framework designed for High Energy and Nuclear Physics experimental data reconstruction. It excels in multi-threaded processing, ensuring maximum efficiency and scalability. With its intuitive setup and extensive customization options, JANA2 empowers both novice and experienced programmers to contribute effectively. Whether running on a local machine or a large computing cluster, JANA2 optimizes performance, making it the ideal choice for any scale of project.

- Read more information on [MAIN DOCUMENTATION](https://JeffersonLab.github.io/JANA2/) website
- Contribute [on GitHub](https://github.com/JeffersonLab/JANA2)

This website provides documentation for JANA2 C++ API automatically generated by Doxygen.

## Main API

Expand Down

0 comments on commit 5171df3

Please sign in to comment.