From cb5aea4bfcbd7fecfdb310cac3db1e47ced7e6fa Mon Sep 17 00:00:00 2001 From: Kartik Kumar Date: Sat, 27 Jan 2024 09:23:22 +0100 Subject: [PATCH] Update Doxygen docs. --- docs/CMakeLists.txt | 2 +- docs/html/README_8md.html | 12 +- docs/html/astroAll_8hpp.html | 12 +- docs/html/astroAll_8hpp_source.html | 17 +- .../centralBodyAccelerationModel_8hpp.html | 16 +- ...tralBodyAccelerationModel_8hpp_source.html | 25 +- docs/html/clipboard.js | 61 ++ docs/html/constants_8hpp.html | 28 +- docs/html/constants_8hpp_source.html | 31 +- docs/html/cookie.js | 58 ++ .../dir_0fc3206047eab508bd310c9d22a11fd1.html | 12 +- .../dir_d44c64559bbebec7f509842c48db8b23.html | 12 +- docs/html/doxygen.css | 282 +++++- docs/html/doxygen_crawl.html | 65 ++ docs/html/dynsections.js | 265 +++-- docs/html/files.html | 18 +- docs/html/graph_legend.html | 12 +- docs/html/index.html | 21 +- docs/html/j2AccelerationModel_8hpp.html | 16 +- .../html/j2AccelerationModel_8hpp_source.html | 21 +- docs/html/menu.js | 34 +- docs/html/minus.svg | 8 + docs/html/minusd.svg | 8 + docs/html/namespaceastro.html | 474 +++------ docs/html/namespacemembers.html | 12 +- docs/html/namespacemembers_enum.html | 12 +- docs/html/namespacemembers_eval.html | 12 +- docs/html/namespacemembers_func.html | 12 +- docs/html/namespacemembers_vars.html | 12 +- docs/html/namespaces.html | 12 +- docs/html/navtree.css | 1 - docs/html/navtree.js | 832 +++++++--------- docs/html/orbitalElementConversions_8hpp.html | 42 +- ...orbitalElementConversions_8hpp_source.html | 73 +- docs/html/pages.html | 12 +- docs/html/plus.svg | 9 + docs/html/plusd.svg | 9 + ...diationPressureAccelerationModel_8hpp.html | 22 +- ...PressureAccelerationModel_8hpp_source.html | 33 +- docs/html/resize.js | 100 +- docs/html/search/all_0.js | 2 +- docs/html/search/all_1.js | 27 +- docs/html/search/all_10.js | 5 + docs/html/search/all_11.js | 5 + docs/html/search/all_12.js | 5 + docs/html/search/all_2.js | 28 +- docs/html/search/all_3.js | 2 +- docs/html/search/all_4.js | 2 +- docs/html/search/all_5.js | 2 +- docs/html/search/all_6.js | 3 +- docs/html/search/all_7.js | 2 +- docs/html/search/all_8.js | 2 +- docs/html/search/all_9.js | 4 +- docs/html/search/all_a.js | 4 +- docs/html/search/all_b.js | 7 +- docs/html/search/all_c.js | 3 +- docs/html/search/all_d.js | 5 +- docs/html/search/all_e.js | 6 +- docs/html/search/all_f.js | 9 + docs/html/search/pages_1.js | 2 +- docs/html/search/pages_2.js | 4 + docs/html/search/search.js | 934 ++++++++---------- docs/html/search/searchdata.js | 4 +- docs/html/stateVectorIndices_8hpp.html | 18 +- docs/html/stateVectorIndices_8hpp_source.html | 59 +- docs/html/tabs.css | 2 +- docs/html/todo.html | 12 +- docs/html/twoBodyMethods_8hpp.html | 20 +- docs/html/twoBodyMethods_8hpp_source.html | 29 +- 69 files changed, 2090 insertions(+), 1832 deletions(-) create mode 100644 docs/html/clipboard.js create mode 100644 docs/html/cookie.js create mode 100644 docs/html/doxygen_crawl.html create mode 100644 docs/html/minus.svg create mode 100644 docs/html/minusd.svg create mode 100644 docs/html/plus.svg create mode 100644 docs/html/plusd.svg create mode 100644 docs/html/search/all_10.js create mode 100644 docs/html/search/all_11.js create mode 100644 docs/html/search/all_12.js create mode 100644 docs/html/search/all_f.js create mode 100644 docs/html/search/pages_2.js diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index bac4d18..950df1c 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -17,7 +17,7 @@ set(DOXYGEN_QUIET YES) set(DOXYGEN_WARN_NO_PARAMDOC YES) set(DOXYGEN_RECURSIVE YES) set(DOXYGEN_EXCLUDE "*.cpp") -set(DOXYGEN_USE_MDFILE_AS_MAINPAGE README.md) +set(DOXYGEN_USE_MDFILE_AS_MAINPAGE "${PROJECT_SOURCE_DIR}/README.md") set(DOXYGEN_SOURCE_BROWSER YES) set(DOXYGEN_REFERENCED_BY_RELATION YES) set(DOXYGEN_REFERENCES_RELATION YES) diff --git a/docs/html/README_8md.html b/docs/html/README_8md.html index f66beec..7eff519 100644 --- a/docs/html/README_8md.html +++ b/docs/html/README_8md.html @@ -3,16 +3,18 @@ - + astro: README.md File Reference + + @@ -34,7 +36,7 @@ - + @@ -64,7 +66,7 @@
@@ -99,7 +101,7 @@ diff --git a/docs/html/astroAll_8hpp.html b/docs/html/astroAll_8hpp.html index 3f2cb53..6626181 100644 --- a/docs/html/astroAll_8hpp.html +++ b/docs/html/astroAll_8hpp.html @@ -3,16 +3,18 @@ - + astro: astroAll.hpp File Reference + + @@ -34,7 +36,7 @@
- + @@ -64,7 +66,7 @@
@@ -149,7 +151,7 @@ diff --git a/docs/html/astroAll_8hpp_source.html b/docs/html/astroAll_8hpp_source.html index b9d64c8..ae07d58 100644 --- a/docs/html/astroAll_8hpp_source.html +++ b/docs/html/astroAll_8hpp_source.html @@ -3,16 +3,18 @@ - + astro: astroAll.hpp Source File + + @@ -34,7 +36,7 @@
- + +
@@ -121,7 +128,7 @@ diff --git a/docs/html/centralBodyAccelerationModel_8hpp.html b/docs/html/centralBodyAccelerationModel_8hpp.html index 609aac0..f80fc28 100644 --- a/docs/html/centralBodyAccelerationModel_8hpp.html +++ b/docs/html/centralBodyAccelerationModel_8hpp.html @@ -3,16 +3,18 @@ - + astro: centralBodyAccelerationModel.hpp File Reference + + @@ -34,7 +36,7 @@
- + @@ -64,7 +66,7 @@
@@ -122,12 +124,12 @@ - +

Namespaces

namespace  astro
namespace  astro
 
- + @@ -138,7 +140,7 @@ diff --git a/docs/html/centralBodyAccelerationModel_8hpp_source.html b/docs/html/centralBodyAccelerationModel_8hpp_source.html index d87eb5e..df6543b 100644 --- a/docs/html/centralBodyAccelerationModel_8hpp_source.html +++ b/docs/html/centralBodyAccelerationModel_8hpp_source.html @@ -3,16 +3,18 @@ - +astro: centralBodyAccelerationModel.hpp Source File + + @@ -34,7 +36,7 @@

Functions

template<typename Real , typename Vector3 >
template<typename Real , typename Vector3 >
Vector3 astro::computeCentralBodyAcceleration (const Real gravitationalParameter, const Vector3 &position)
 Compute the acceleration of a point mass body orbiting a uniform central body.
 
- + +
@@ -106,11 +113,13 @@
11
12#include <cmath>
13
+
14namespace astro
15{
16
18
40template <typename Real, typename Vector3>
+
41Vector3 computeCentralBodyAcceleration(const Real gravitationalParameter,
42 const Vector3& position)
43{
@@ -128,17 +137,19 @@
55
56 return acceleration;
57}
+
58
59} // namespace astro
- -
Vector3 computeCentralBodyAcceleration(const Real gravitationalParameter, const Vector3 &position)
Compute the acceleration of a point mass body orbiting a uniform central body.
+
+ +
Vector3 computeCentralBodyAcceleration(const Real gravitationalParameter, const Vector3 &position)
Compute the acceleration of a point mass body orbiting a uniform central body.
diff --git a/docs/html/clipboard.js b/docs/html/clipboard.js new file mode 100644 index 0000000..42c1fb0 --- /dev/null +++ b/docs/html/clipboard.js @@ -0,0 +1,61 @@ +/** + +The code below is based on the Doxygen Awesome project, see +https://github.com/jothepro/doxygen-awesome-css + +MIT License + +Copyright (c) 2021 - 2022 jothepro + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +*/ + +let clipboard_title = "Copy to clipboard" +let clipboard_icon = `` +let clipboard_successIcon = `` +let clipboard_successDuration = 1000 + +$(function() { + if(navigator.clipboard) { + const fragments = document.getElementsByClassName("fragment") + for(const fragment of fragments) { + const clipboard_div = document.createElement("div") + clipboard_div.classList.add("clipboard") + clipboard_div.innerHTML = clipboard_icon + clipboard_div.title = clipboard_title + $(clipboard_div).click(function() { + const content = this.parentNode.cloneNode(true) + // filter out line number and folded fragments from file listings + content.querySelectorAll(".lineno, .ttc, .foldclosed").forEach((node) => { node.remove() }) + let text = content.textContent + // remove trailing newlines and trailing spaces from empty lines + text = text.replace(/^\s*\n/gm,'\n').replace(/\n*$/,'') + navigator.clipboard.writeText(text); + this.classList.add("success") + this.innerHTML = clipboard_successIcon + window.setTimeout(() => { // switch back to normal icon after timeout + this.classList.remove("success") + this.innerHTML = clipboard_icon + }, clipboard_successDuration); + }) + fragment.insertBefore(clipboard_div, fragment.firstChild) + } + } +}) diff --git a/docs/html/constants_8hpp.html b/docs/html/constants_8hpp.html index 6160618..71e8caa 100644 --- a/docs/html/constants_8hpp.html +++ b/docs/html/constants_8hpp.html @@ -3,16 +3,18 @@ - + astro: constants.hpp File Reference + + @@ -34,7 +36,7 @@ - + @@ -64,7 +66,7 @@
@@ -117,30 +119,30 @@ - +

Namespaces

namespace  astro
namespace  astro
 
- + - + - + - + - + - + - +

Variables

static const double astro::ASTRO_GRAVITATIONAL_CONSTANT = 6.67259e-11
static const double astro::ASTRO_GRAVITATIONAL_CONSTANT = 6.67259e-11
 Gravitational constant [m^3 s^-2] (Standish, 1995).
 
static const double astro::ASTRO_JULIAN_DAY_IN_SECONDS = 86400.0
static const double astro::ASTRO_JULIAN_DAY_IN_SECONDS = 86400.0
 Julian day in seconds (NASA, 2012).
 
static const double astro::ASTRO_JULIAN_YEAR_IN_DAYS = 365.25
static const double astro::ASTRO_JULIAN_YEAR_IN_DAYS = 365.25
 Julian year in days (NASA, 2012).
 
static const double astro::ASTRO_JULIAN_YEAR_IN_SECONDS = 3.15576e7
static const double astro::ASTRO_JULIAN_YEAR_IN_SECONDS = 3.15576e7
 Julian year in seconds.
 
static const double astro::ASTRO_AU_IN_KM = 149597870.7
static const double astro::ASTRO_AU_IN_KM = 149597870.7
 Astronautical Unit in km (NASA, 2012).
 
static const double astro::ASTRO_GREGORIAN_EPOCH_IN_JULIAN_DAYS = 1721425.5
static const double astro::ASTRO_GREGORIAN_EPOCH_IN_JULIAN_DAYS = 1721425.5
 Start of Gregorian epoch in Julian days (Ramsey, 2016).
 
static const double astro::ASTRO_SPEED_OF_LIGHT = 299792458.0
static const double astro::ASTRO_SPEED_OF_LIGHT = 299792458.0
 Speed of light [m s^-1] (Wikipedia, 2018).
 
@@ -150,7 +152,7 @@ diff --git a/docs/html/constants_8hpp_source.html b/docs/html/constants_8hpp_source.html index e7197fa..ed7e25a 100644 --- a/docs/html/constants_8hpp_source.html +++ b/docs/html/constants_8hpp_source.html @@ -3,16 +3,18 @@ - + astro: constants.hpp Source File + + @@ -34,7 +36,7 @@
- + +
@@ -124,20 +131,20 @@
36} // namespace astro
37
-
static const double ASTRO_GRAVITATIONAL_CONSTANT
Gravitational constant [m^3 s^-2] (Standish, 1995).
Definition constants.hpp:16
-
static const double ASTRO_JULIAN_DAY_IN_SECONDS
Julian day in seconds (NASA, 2012).
Definition constants.hpp:19
-
static const double ASTRO_JULIAN_YEAR_IN_DAYS
Julian year in days (NASA, 2012).
Definition constants.hpp:22
-
static const double ASTRO_SPEED_OF_LIGHT
Speed of light [m s^-1] (Wikipedia, 2018).
Definition constants.hpp:34
-
static const double ASTRO_AU_IN_KM
Astronautical Unit in km (NASA, 2012).
Definition constants.hpp:28
-
static const double ASTRO_GREGORIAN_EPOCH_IN_JULIAN_DAYS
Start of Gregorian epoch in Julian days (Ramsey, 2016).
Definition constants.hpp:31
-
static const double ASTRO_JULIAN_YEAR_IN_SECONDS
Julian year in seconds.
Definition constants.hpp:25
+
static const double ASTRO_GRAVITATIONAL_CONSTANT
Gravitational constant [m^3 s^-2] (Standish, 1995).
Definition constants.hpp:16
+
static const double ASTRO_JULIAN_DAY_IN_SECONDS
Julian day in seconds (NASA, 2012).
Definition constants.hpp:19
+
static const double ASTRO_JULIAN_YEAR_IN_DAYS
Julian year in days (NASA, 2012).
Definition constants.hpp:22
+
static const double ASTRO_SPEED_OF_LIGHT
Speed of light [m s^-1] (Wikipedia, 2018).
Definition constants.hpp:34
+
static const double ASTRO_AU_IN_KM
Astronautical Unit in km (NASA, 2012).
Definition constants.hpp:28
+
static const double ASTRO_GREGORIAN_EPOCH_IN_JULIAN_DAYS
Start of Gregorian epoch in Julian days (Ramsey, 2016).
Definition constants.hpp:31
+
static const double ASTRO_JULIAN_YEAR_IN_SECONDS
Julian year in seconds.
Definition constants.hpp:25
diff --git a/docs/html/cookie.js b/docs/html/cookie.js new file mode 100644 index 0000000..53ad21d --- /dev/null +++ b/docs/html/cookie.js @@ -0,0 +1,58 @@ +/*! + Cookie helper functions + Copyright (c) 2023 Dimitri van Heesch + Released under MIT license. +*/ +let Cookie = { + cookie_namespace: 'doxygen_', + + readSetting(cookie,defVal) { + if (window.chrome) { + const val = localStorage.getItem(this.cookie_namespace+cookie) || + sessionStorage.getItem(this.cookie_namespace+cookie); + if (val) return val; + } else { + let myCookie = this.cookie_namespace+cookie+"="; + if (document.cookie) { + const index = document.cookie.indexOf(myCookie); + if (index != -1) { + const valStart = index + myCookie.length; + let valEnd = document.cookie.indexOf(";", valStart); + if (valEnd == -1) { + valEnd = document.cookie.length; + } + return document.cookie.substring(valStart, valEnd); + } + } + } + return defVal; + }, + + writeSetting(cookie,val,days=10*365) { // default days='forever', 0=session cookie, -1=delete + if (window.chrome) { + if (days==0) { + sessionStorage.setItem(this.cookie_namespace+cookie,val); + } else { + localStorage.setItem(this.cookie_namespace+cookie,val); + } + } else { + let date = new Date(); + date.setTime(date.getTime()+(days*24*60*60*1000)); + const expiration = days!=0 ? "expires="+date.toGMTString()+";" : ""; + document.cookie = this.cookie_namespace + cookie + "=" + + val + "; SameSite=Lax;" + expiration + "path=/"; + } + }, + + eraseSetting(cookie) { + if (window.chrome) { + if (localStorage.getItem(this.cookie_namespace+cookie)) { + localStorage.removeItem(this.cookie_namespace+cookie); + } else if (sessionStorage.getItem(this.cookie_namespace+cookie)) { + sessionStorage.removeItem(this.cookie_namespace+cookie); + } + } else { + this.writeSetting(cookie,'',-1); + } + }, +} diff --git a/docs/html/dir_0fc3206047eab508bd310c9d22a11fd1.html b/docs/html/dir_0fc3206047eab508bd310c9d22a11fd1.html index 090f7c8..caba27b 100644 --- a/docs/html/dir_0fc3206047eab508bd310c9d22a11fd1.html +++ b/docs/html/dir_0fc3206047eab508bd310c9d22a11fd1.html @@ -3,16 +3,18 @@ - + astro: astro Directory Reference + + @@ -34,7 +36,7 @@ - + @@ -64,7 +66,7 @@
@@ -128,7 +130,7 @@ diff --git a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html index c61ac6e..709413d 100644 --- a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html +++ b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html @@ -3,16 +3,18 @@ - + astro: include Directory Reference + + @@ -34,7 +36,7 @@
- + @@ -64,7 +66,7 @@
@@ -105,7 +107,7 @@ diff --git a/docs/html/doxygen.css b/docs/html/doxygen.css index 0caa19b..7b7d851 100644 --- a/docs/html/doxygen.css +++ b/docs/html/doxygen.css @@ -1,4 +1,4 @@ -/* The standard CSS for doxygen 1.9.7*/ +/* The standard CSS for doxygen 1.10.0*/ html { /* page base colors */ @@ -145,6 +145,7 @@ html { --fragment-lineno-link-bg-color: #D8D8D8; --fragment-lineno-link-hover-fg-color: #4665A2; --fragment-lineno-link-hover-bg-color: #C8C8C8; +--fragment-copy-ok-color: #2EC82E; --tooltip-foreground-color: black; --tooltip-background-color: white; --tooltip-border-color: gray; @@ -152,6 +153,11 @@ html { --tooltip-declaration-color: #006318; --tooltip-link-color: #4665A2; --tooltip-shadow: 1px 1px 7px gray; +--fold-line-color: #808080; +--fold-minus-image: url('minus.svg'); +--fold-plus-image: url('plus.svg'); +--fold-minus-image-relpath: url('../../minus.svg'); +--fold-plus-image-relpath: url('../../plus.svg'); /** font-family */ --font-family-normal: Roboto,sans-serif; @@ -163,6 +169,28 @@ html { --font-family-icon: Arial,Helvetica; --font-family-tooltip: Roboto,sans-serif; +/** special sections */ +--warning-color-bg: #f8d1cc; +--warning-color-hl: #b61825; +--warning-color-text: #75070f; +--note-color-bg: #faf3d8; +--note-color-hl: #f3a600; +--note-color-text: #5f4204; +--todo-color-bg: #e4f3ff; +--todo-color-hl: #1879C4; +--todo-color-text: #274a5c; +--test-color-bg: #e8e8ff; +--test-color-hl: #3939C4; +--test-color-text: #1a1a5c; +--deprecated-color-bg: #ecf0f3; +--deprecated-color-hl: #5b6269; +--deprecated-color-text: #43454a; +--bug-color-bg: #e4dafd; +--bug-color-hl: #5b2bdd; +--bug-color-text: #2a0d72; +--invariant-color-bg: #d8f1e3; +--invariant-color-hl: #44b86f; +--invariant-color-text: #265532; } @media (prefers-color-scheme: dark) { @@ -298,13 +326,13 @@ html { --code-char-literal-color: #00E0F0; --code-xml-cdata-color: #C9D1D9; --code-vhdl-digit-color: #FF00FF; ---code-vhdl-char-color: #000000; ---code-vhdl-keyword-color: #700070; +--code-vhdl-char-color: #C0C0C0; +--code-vhdl-keyword-color: #CF53C9; --code-vhdl-logic-color: #FF0000; --code-link-color: #79C0FF; --code-external-link-color: #79C0FF; --fragment-foreground-color: #C9D1D9; ---fragment-background-color: black; +--fragment-background-color: #090D16; --fragment-border-color: #30363D; --fragment-lineno-border-color: #30363D; --fragment-lineno-background-color: black; @@ -313,6 +341,7 @@ html { --fragment-lineno-link-bg-color: #303030; --fragment-lineno-link-hover-fg-color: #8E96A1; --fragment-lineno-link-hover-bg-color: #505050; +--fragment-copy-ok-color: #0EA80E; --tooltip-foreground-color: #C9D1D9; --tooltip-background-color: #202020; --tooltip-border-color: #C9D1D9; @@ -320,6 +349,11 @@ html { --tooltip-declaration-color: #20C348; --tooltip-link-color: #79C0FF; --tooltip-shadow: none; +--fold-line-color: #808080; +--fold-minus-image: url('minusd.svg'); +--fold-plus-image: url('plusd.svg'); +--fold-minus-image-relpath: url('../../minusd.svg'); +--fold-plus-image-relpath: url('../../plusd.svg'); /** font-family */ --font-family-normal: Roboto,sans-serif; @@ -331,6 +365,28 @@ html { --font-family-icon: Arial,Helvetica; --font-family-tooltip: Roboto,sans-serif; +/** special sections */ +--warning-color-bg: #2e1917; +--warning-color-hl: #ad2617; +--warning-color-text: #f5b1aa; +--note-color-bg: #3b2e04; +--note-color-hl: #f1b602; +--note-color-text: #ceb670; +--todo-color-bg: #163750; +--todo-color-hl: #1982D2; +--todo-color-text: #dcf0fa; +--test-color-bg: #121258; +--test-color-hl: #4242cf; +--test-color-text: #c0c0da; +--deprecated-color-bg: #2e323b; +--deprecated-color-hl: #738396; +--deprecated-color-text: #abb0bd; +--bug-color-bg: #2a2536; +--bug-color-hl: #7661b3; +--bug-color-text: #ae9ed6; +--invariant-color-bg: #303a35; +--invariant-color-hl: #76ce96; +--invariant-color-text: #cceed5; }} body { background-color: var(--page-background-color); @@ -347,8 +403,6 @@ body, table, div, p, dl { /* @group Heading Levels */ .title { - font-weight: 400; - font-size: 14px; font-family: var(--font-family-normal); line-height: 28px; font-size: 150%; @@ -481,6 +535,12 @@ div.qindex{ color: var(--index-separator-color); } +#main-menu a:focus { + outline: auto; + z-index: 10; + position: relative; +} + dt.alphachar{ font-size: 180%; font-weight: bold; @@ -540,7 +600,13 @@ a { } a:hover { - text-decoration: underline; + text-decoration: none; + background: linear-gradient(to bottom, transparent 0,transparent calc(100% - 1px), currentColor 100%); +} + +a:hover > span.arrow { + text-decoration: none; + background : var(--nav-background-color); } a.el { @@ -616,30 +682,63 @@ ul.multicol { .fragment { text-align: left; direction: ltr; - overflow-x: auto; /*Fixed: fragment lines overlap floating elements*/ + overflow-x: auto; overflow-y: hidden; + position: relative; + min-height: 12px; + margin: 10px 0px; + padding: 10px 10px; + border: 1px solid var(--fragment-border-color); + border-radius: 4px; + background-color: var(--fragment-background-color); + color: var(--fragment-foreground-color); } pre.fragment { - border: 1px solid var(--fragment-border-color); - background-color: var(--fragment-background-color); - color: var(--fragment-foreground-color); - padding: 4px 6px; - margin: 4px 8px 4px 2px; + word-wrap: break-word; + font-size: 10pt; + line-height: 125%; + font-family: var(--font-family-monospace); +} + +.clipboard { + width: 24px; + height: 24px; + right: 5px; + top: 5px; + opacity: 0; + position: absolute; + display: inline; overflow: auto; - word-wrap: break-word; - font-size: 9pt; - line-height: 125%; - font-family: var(--font-family-monospace); - font-size: 105%; + fill: var(--fragment-foreground-color); + justify-content: center; + align-items: center; + cursor: pointer; +} + +.clipboard.success { + border: 1px solid var(--fragment-foreground-color); + border-radius: 4px; +} + +.fragment:hover .clipboard, .clipboard.success { + opacity: .28; +} + +.clipboard:hover, .clipboard.success { + opacity: 1 !important; +} + +.clipboard:active:not([class~=success]) svg { + transform: scale(.91); } -div.fragment { - padding: 0 0 1px 0; /*Fixed: last line underline overlap border*/ - margin: 4px 8px 4px 2px; - color: var(--fragment-foreground-color); - background-color: var(--fragment-background-color); - border: 1px solid var(--fragment-border-color); +.clipboard.success svg { + fill: var(--fragment-copy-ok-color); +} + +.clipboard.success { + border-color: var(--fragment-copy-ok-color); } div.line { @@ -679,6 +778,18 @@ div.line.glow { box-shadow: 0 0 10px var(--glow-color); } +span.fold { + margin-left: 5px; + margin-right: 1px; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; + display: inline-block; + width: 12px; + height: 12px; + background-repeat:no-repeat; + background-position:center; +} span.lineno { padding-right: 4px; @@ -750,10 +861,6 @@ img.light-mode-visible { display: none; } -img.formulaDsp { - -} - img.formulaInl, img.inline { vertical-align: middle; } @@ -1053,17 +1160,25 @@ dl.reflist dd { .paramtype { white-space: nowrap; + padding: 0px; + padding-bottom: 1px; } .paramname { - color: var(--memdef-param-name-color); white-space: nowrap; + padding: 0px; + padding-bottom: 1px; + margin-left: 2px; } + .paramname em { + color: var(--memdef-param-name-color); font-style: normal; + margin-right: 1px; } -.paramname code { - line-height: 14px; + +.paramname .paramdefval { + font-family: var(--font-family-monospace); } .params, .retval, .exception, .tparams { @@ -1397,7 +1512,6 @@ table.fieldtable { { height:32px; display:block; - text-decoration: none; outline: none; color: var(--nav-text-normal-color); font-family: var(--font-family-nav); @@ -1486,7 +1600,8 @@ dl { padding: 0 0 0 0; } -/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug, dl.examples */ +/* + dl.section { margin-left: 0px; padding-left: 0px; @@ -1541,8 +1656,101 @@ dl.bug { border-color: #C08050; } +*/ + +dl.bug dt a, dl.deprecated dt a, dl.todo dt a, dl.test a { + font-weight: bold !important; +} + +dl.warning, dl.attention, dl.note, dl.deprecated, dl.bug, +dl.invariant, dl.pre, dl.post, dl.todo, dl.test, dl.remark { + padding: 10px; + margin: 10px 0px; + overflow: hidden; + margin-left: 0; + border-radius: 4px; +} + dl.section dd { - margin-bottom: 6px; + margin-bottom: 2px; +} + +dl.warning, dl.attention { + background: var(--warning-color-bg); + border-left: 8px solid var(--warning-color-hl); + color: var(--warning-color-text); +} + +dl.warning dt, dl.attention dt { + color: var(--warning-color-hl); +} + +dl.note, dl.remark { + background: var(--note-color-bg); + border-left: 8px solid var(--note-color-hl); + color: var(--note-color-text); +} + +dl.note dt, dl.remark dt { + color: var(--note-color-hl); +} + +dl.todo { + background: var(--todo-color-bg); + border-left: 8px solid var(--todo-color-hl); + color: var(--todo-color-text); +} + +dl.todo dt { + color: var(--todo-color-hl); +} + +dl.test { + background: var(--test-color-bg); + border-left: 8px solid var(--test-color-hl); + color: var(--test-color-text); +} + +dl.test dt { + color: var(--test-color-hl); +} + +dl.bug dt a { + color: var(--bug-color-hl) !important; +} + +dl.bug { + background: var(--bug-color-bg); + border-left: 8px solid var(--bug-color-hl); + color: var(--bug-color-text); +} + +dl.bug dt a { + color: var(--bug-color-hl) !important; +} + +dl.deprecated { + background: var(--deprecated-color-bg); + border-left: 8px solid var(--deprecated-color-hl); + color: var(--deprecated-color-text); +} + +dl.deprecated dt a { + color: var(--deprecated-color-hl) !important; +} + +dl.section dd, dl.bug dd, dl.deprecated dd, dl.todo dd, dl.test dd { + margin-inline-start: 0px; +} + +dl.invariant, dl.pre, dl.post { + background: var(--invariant-color-bg); + border-left: 8px solid var(--invariant-color-hl); + color: var(--invariant-color-text); +} + +dl.invariant dt, dl.pre dt, dl.post dt { + color: var(--invariant-color-hl); } @@ -1557,12 +1765,12 @@ dl.section dd { vertical-align: bottom; border-collapse: separate; } - + #projectlogo img -{ +{ border: 0px none; } - + #projectalign { vertical-align: middle; diff --git a/docs/html/doxygen_crawl.html b/docs/html/doxygen_crawl.html new file mode 100644 index 0000000..7433db7 --- /dev/null +++ b/docs/html/doxygen_crawl.html @@ -0,0 +1,65 @@ + + + +Validator / crawler helper + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/dynsections.js b/docs/html/dynsections.js index 1f4cd14..24dfe9c 100644 --- a/docs/html/dynsections.js +++ b/docs/html/dynsections.js @@ -22,106 +22,177 @@ @licend The above is the entire license notice for the JavaScript code in this file */ -function toggleVisibility(linkObj) -{ - var base = $(linkObj).attr('id'); - var summary = $('#'+base+'-summary'); - var content = $('#'+base+'-content'); - var trigger = $('#'+base+'-trigger'); - var src=$(trigger).attr('src'); - if (content.is(':visible')===true) { - content.hide(); - summary.show(); - $(linkObj).addClass('closed').removeClass('opened'); - $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png'); - } else { - content.show(); - summary.hide(); - $(linkObj).removeClass('closed').addClass('opened'); - $(trigger).attr('src',src.substring(0,src.length-10)+'open.png'); - } - return false; -} - -function updateStripes() -{ - $('table.directory tr'). - removeClass('even').filter(':visible:even').addClass('even'); - $('table.directory tr'). - removeClass('odd').filter(':visible:odd').addClass('odd'); -} - -function toggleLevel(level) -{ - $('table.directory tr').each(function() { - var l = this.id.split('_').length-1; - var i = $('#img'+this.id.substring(3)); - var a = $('#arr'+this.id.substring(3)); - if (l'); + // add vertical lines to other rows + $('span[class=lineno]').not(':eq(0)').append(''); + // add toggle controls to lines with fold divs + $('div[class=foldopen]').each(function() { + // extract specific id to use + const id = $(this).attr('id').replace('foldopen',''); + // extract start and end foldable fragment attributes + const start = $(this).attr('data-start'); + const end = $(this).attr('data-end'); + // replace normal fold span with controls for the first line of a foldable fragment + $(this).find('span[class=fold]:first').replaceWith(''); + // append div for folded (closed) representation + $(this).after(''); + // extract the first line from the "open" section to represent closed content + const line = $(this).children().first().clone(); + // remove any glow that might still be active on the original line + $(line).removeClass('glow'); + if (start) { + // if line already ends with a start marker (e.g. trailing {), remove it + $(line).html($(line).html().replace(new RegExp('\\s*'+start+'\\s*$','g'),'')); + } + // replace minus with plus symbol + $(line).find('span[class=fold]').css('background-image',codefold.plusImg[relPath]); + // append ellipsis + $(line).append(' '+start+''+end); + // insert constructed line into closed div + $('#foldclosed'+id).html(line); + }); + }, +}; /* @license-end */ -$(document).ready(function() { +$(function() { $('.code,.codeRef').each(function() { $(this).data('powertip',$('#a'+$(this).attr('href').replace(/.*\//,'').replace(/[^a-z_A-Z0-9]/g,'_')).html()); $.fn.powerTip.smartPlacementLists.s = [ 's', 'n', 'ne', 'se' ]; diff --git a/docs/html/files.html b/docs/html/files.html index d8fd289..92fc325 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -3,16 +3,18 @@ - + astro: File List + + @@ -34,7 +36,7 @@
- + @@ -64,7 +66,7 @@
@@ -94,9 +96,9 @@
Here is a list of all files with brief descriptions:
-
[detail level 123]
- - +
[detail level 123]
  include
  astro
+ + @@ -112,7 +114,7 @@ diff --git a/docs/html/graph_legend.html b/docs/html/graph_legend.html index f193488..1d759da 100644 --- a/docs/html/graph_legend.html +++ b/docs/html/graph_legend.html @@ -3,16 +3,18 @@ - +astro: Graph Legend + + @@ -34,7 +36,7 @@
  include
  astro
 astroAll.hpp
 centralBodyAccelerationModel.hpp
 constants.hpp
- + @@ -64,7 +66,7 @@
@@ -158,7 +160,7 @@ diff --git a/docs/html/index.html b/docs/html/index.html index 5f0d330..eeeeb2a 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -3,16 +3,18 @@ - + astro: astro + + @@ -34,7 +36,7 @@
- + @@ -64,7 +66,7 @@
@@ -176,17 +178,18 @@

The copyright holders are not liable for any damage(s) incurred due to improper use of astro.

TODO

-
Todo:
Find a way to provide an option to clean installation.
-
Todo:
Find a way to remove workaround to get Doxygen to not throw warnings in readme.
-
Todo:
Find a way to have nested variables in Doxygen config file so that e.g., @@CMAKE_PROJECT_NAME@_VERSION@ works.
-
Todo:
Add version detection in CMake module so that find_package respects minimum version required.
+
Todo
Find a way to provide an option to clean installation.
+
Todo
Find a way to remove workaround to get Doxygen to not throw warnings in readme.
+
Todo
Find a way to have nested variables in Doxygen config file so that e.g., @@CMAKE_PROJECT_NAME@_VERSION@ works.
+
Todo
Add version detection in CMake module so that find_package respects minimum version required.
+ diff --git a/docs/html/j2AccelerationModel_8hpp.html b/docs/html/j2AccelerationModel_8hpp.html index d88db26..0d02723 100644 --- a/docs/html/j2AccelerationModel_8hpp.html +++ b/docs/html/j2AccelerationModel_8hpp.html @@ -3,16 +3,18 @@ - + astro: j2AccelerationModel.hpp File Reference + + @@ -34,7 +36,7 @@ - + @@ -64,7 +66,7 @@
@@ -122,12 +124,12 @@ - +

Namespaces

namespace  astro
namespace  astro
 
- + @@ -138,7 +140,7 @@ diff --git a/docs/html/j2AccelerationModel_8hpp_source.html b/docs/html/j2AccelerationModel_8hpp_source.html index 89165a3..148e9e0 100644 --- a/docs/html/j2AccelerationModel_8hpp_source.html +++ b/docs/html/j2AccelerationModel_8hpp_source.html @@ -3,16 +3,18 @@ - +astro: j2AccelerationModel.hpp Source File + + @@ -34,7 +36,7 @@

Functions

template<typename Real , typename Vector3 >
template<typename Real , typename Vector3 >
Vector3 astro::computeJ2Acceleration (const Real gravitationalParameter, const Vector3 &position, const Real equatorialRadius, const Real j2Coefficient)
 Compute gravitational acceleration due to J2.
 
- + +
@@ -108,6 +115,7 @@
13
15
46template <typename Real, typename Vector3>
+
47Vector3 computeJ2Acceleration(const Real gravitationalParameter,
48 const Vector3& position,
49 const Real equatorialRadius,
@@ -132,17 +140,18 @@
68
69 return acceleration;
70}
+
71
72} // namespace astro
-
Vector3 computeJ2Acceleration(const Real gravitationalParameter, const Vector3 &position, const Real equatorialRadius, const Real j2Coefficient)
Compute gravitational acceleration due to J2.
+
Vector3 computeJ2Acceleration(const Real gravitationalParameter, const Vector3 &position, const Real equatorialRadius, const Real j2Coefficient)
Compute gravitational acceleration due to J2.
diff --git a/docs/html/menu.js b/docs/html/menu.js index b0b2693..717761d 100644 --- a/docs/html/menu.js +++ b/docs/html/menu.js @@ -24,13 +24,12 @@ */ function initMenu(relPath,searchEnabled,serverSide,searchPage,search) { function makeTree(data,relPath) { - var result=''; + let result=''; if ('children' in data) { result+='