Skip to content

Commit

Permalink
Add apidoc
Browse files Browse the repository at this point in the history
  • Loading branch information
attipaci committed Aug 29, 2024
1 parent caa86d2 commit c891f93
Show file tree
Hide file tree
Showing 284 changed files with 64,135 additions and 1,573 deletions.
45 changes: 24 additions & 21 deletions apidoc/html/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,28 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=X-XXXXXXXX"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'X-XXXXXXX');
</script>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta charset="utf-8"/>
<meta name="description" content="Structured data exchange for C/C++"/>
<meta name="keywords" content="structured data, data exchange, C, C++, library"/>
<meta name="description" content="SuperNOVAS C/C++ astrometry library"/>
<meta name="keywords" content="astronomy, astrometry, C, C++, library, NOVAS"/>
<meta name="author" content="Attila Kovacs"/>
<meta name="copyright" content="(C)2024 Attila Kovacs" />
<meta name="robots" content="index,follow"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<script async src="https://www.googletagmanager.com/gtag/js?id=X-XXXXXXXXXXX"></script>
<script async src="https://www.googletagmanager.com/gtag/js?id=G-HLFWKSM8V9"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'X-XXXXXXXX');
gtag('config', 'G-HLFWKSM8V9');
</script>
<link rel="shortcut icon" type="image/x-icon" href="/xchange/resources/favicon.ico" />
<link rel="icon" type="image/png" sizes="192x192" href="/xchange/resources/android-chrome-192x192.png" />
<link rel="icon" type="image/png" sizes="512x512" href="/xchange/resources/android-chrome-512x512.png" />
<link rel="apple-touch-icon" type="image/png" href="/xchange/resources/apple-touch-icon.png" />
<title>xchange: Data Structures</title>
<link rel="shortcut icon" type="image/x-icon" href="/SuperNOVAS/resources/favicon.ico" />
<link rel="icon" type="image/png" sizes="192x192" href="/SuperNOVAS/resources/android-chrome-192x192.png" />
<link rel="icon" type="image/png" sizes="512x512" href="/SuperNOVAS/resources/android-chrome-512x512.png" />
<link rel="apple-touch-icon" type="image/png" href="/SuperNOVAS/resources/apple-touch-icon.png" />
<title>SuperNOVAS: Data Structures</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
Expand All @@ -55,9 +47,9 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="smithsonian-logo-55x55.png"/></td>
<td id="projectalign">
<div id="projectname">xchange<span id="projectnumber">&#160;v0.9</span>
<div id="projectname">SuperNOVAS<span id="projectnumber">&#160;v1.2</span>
</div>
<div id="projectbrief">Structured data exchange for C/C++</div>
<div id="projectbrief">The NOVAS C library, made better</div>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -125,8 +117,19 @@
<div class="contents">
<div class="textblock">Here are the data structures with brief descriptions:</div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structXField.html" target="_self">XField</a></td><td class="desc">An SMA-X field, typically as part of an <a class="el" href="structXStructure.html" title="SMA-X structure object, containing a linked-list of XField elements.">XStructure</a>. A field may be a reference to a nested <a class="el" href="structXStructure.html" title="SMA-X structure object, containing a linked-list of XField elements.">XStructure</a> itself </td></tr>
<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structXStructure.html" target="_self">XStructure</a></td><td class="desc">SMA-X structure object, containing a linked-list of <a class="el" href="structXField.html" title="An SMA-X field, typically as part of an XStructure. A field may be a reference to a nested XStructure...">XField</a> elements </td></tr>
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structcat__entry.html" target="_self">cat_entry</a></td><td class="desc"></td></tr>
<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structin__space.html" target="_self">in_space</a></td><td class="desc"></td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structnovas__delaunay__args.html" target="_self">novas_delaunay_args</a></td><td class="desc"></td></tr>
<tr id="row_3_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structnovas__frame.html" target="_self">novas_frame</a></td><td class="desc"></td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structnovas__matrix.html" target="_self">novas_matrix</a></td><td class="desc"></td></tr>
<tr id="row_5_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structnovas__planet__bundle.html" target="_self">novas_planet_bundle</a></td><td class="desc"></td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structnovas__timespec.html" target="_self">novas_timespec</a></td><td class="desc"></td></tr>
<tr id="row_7_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structnovas__transform.html" target="_self">novas_transform</a></td><td class="desc"></td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structobject.html" target="_self">object</a></td><td class="desc"></td></tr>
<tr id="row_9_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structobserver.html" target="_self">observer</a></td><td class="desc"></td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structon__surface.html" target="_self">on_surface</a></td><td class="desc"></td></tr>
<tr id="row_11_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structra__of__cio.html" target="_self">ra_of_cio</a></td><td class="desc"></td></tr>
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structsky__pos.html" target="_self">sky_pos</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
15 changes: 13 additions & 2 deletions apidoc/html/annotated_dup.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
var annotated_dup =
[
[ "XField", "structXField.html", "structXField" ],
[ "XStructure", "structXStructure.html", "structXStructure" ]
[ "cat_entry", "structcat__entry.html", "structcat__entry" ],
[ "in_space", "structin__space.html", "structin__space" ],
[ "novas_delaunay_args", "structnovas__delaunay__args.html", "structnovas__delaunay__args" ],
[ "novas_frame", "structnovas__frame.html", "structnovas__frame" ],
[ "novas_matrix", "structnovas__matrix.html", "structnovas__matrix" ],
[ "novas_planet_bundle", "structnovas__planet__bundle.html", "structnovas__planet__bundle" ],
[ "novas_timespec", "structnovas__timespec.html", "structnovas__timespec" ],
[ "novas_transform", "structnovas__transform.html", "structnovas__transform" ],
[ "object", "structobject.html", "structobject" ],
[ "observer", "structobserver.html", "structobserver" ],
[ "on_surface", "structon__surface.html", "structon__surface" ],
[ "ra_of_cio", "structra__of__cio.html", "structra__of__cio" ],
[ "sky_pos", "structsky__pos.html", "structsky__pos" ]
];
51 changes: 29 additions & 22 deletions apidoc/html/classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,28 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=X-XXXXXXXX"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'X-XXXXXXX');
</script>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta charset="utf-8"/>
<meta name="description" content="Structured data exchange for C/C++"/>
<meta name="keywords" content="structured data, data exchange, C, C++, library"/>
<meta name="description" content="SuperNOVAS C/C++ astrometry library"/>
<meta name="keywords" content="astronomy, astrometry, C, C++, library, NOVAS"/>
<meta name="author" content="Attila Kovacs"/>
<meta name="copyright" content="(C)2024 Attila Kovacs" />
<meta name="robots" content="index,follow"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<script async src="https://www.googletagmanager.com/gtag/js?id=X-XXXXXXXXXXX"></script>
<script async src="https://www.googletagmanager.com/gtag/js?id=G-HLFWKSM8V9"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'X-XXXXXXXX');
gtag('config', 'G-HLFWKSM8V9');
</script>
<link rel="shortcut icon" type="image/x-icon" href="/xchange/resources/favicon.ico" />
<link rel="icon" type="image/png" sizes="192x192" href="/xchange/resources/android-chrome-192x192.png" />
<link rel="icon" type="image/png" sizes="512x512" href="/xchange/resources/android-chrome-512x512.png" />
<link rel="apple-touch-icon" type="image/png" href="/xchange/resources/apple-touch-icon.png" />
<title>xchange: Data Structure Index</title>
<link rel="shortcut icon" type="image/x-icon" href="/SuperNOVAS/resources/favicon.ico" />
<link rel="icon" type="image/png" sizes="192x192" href="/SuperNOVAS/resources/android-chrome-192x192.png" />
<link rel="icon" type="image/png" sizes="512x512" href="/SuperNOVAS/resources/android-chrome-512x512.png" />
<link rel="apple-touch-icon" type="image/png" href="/SuperNOVAS/resources/apple-touch-icon.png" />
<title>SuperNOVAS: Data Structure Index</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
Expand All @@ -55,9 +47,9 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="smithsonian-logo-55x55.png"/></td>
<td id="projectalign">
<div id="projectname">xchange<span id="projectnumber">&#160;v0.9</span>
<div id="projectname">SuperNOVAS<span id="projectnumber">&#160;v1.2</span>
</div>
<div id="projectbrief">Structured data exchange for C/C++</div>
<div id="projectbrief">The NOVAS C library, made better</div>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -123,11 +115,26 @@
<div class="headertitle"><div class="title">Data Structure Index</div></div>
</div><!--header-->
<div class="contents">
<div class="qindex"><a class="qindex" href="#letter_X">X</a></div>
<div class="qindex"><a class="qindex" href="#letter_C">C</a>&#160;|&#160;<a class="qindex" href="#letter_I">I</a>&#160;|&#160;<a class="qindex" href="#letter_N">N</a>&#160;|&#160;<a class="qindex" href="#letter_O">O</a>&#160;|&#160;<a class="qindex" href="#letter_R">R</a>&#160;|&#160;<a class="qindex" href="#letter_S">S</a></div>
<div class="classindex">
<dl class="classindex even">
<dt class="alphachar"><a id="letter_X" name="letter_X">X</a></dt>
<dd><a class="el" href="structXField.html">XField</a></dd><dd><a class="el" href="structXStructure.html">XStructure</a></dd></dl>
<dt class="alphachar"><a id="letter_C" name="letter_C">C</a></dt>
<dd><a class="el" href="structcat__entry.html">cat_entry</a></dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a id="letter_I" name="letter_I">I</a></dt>
<dd><a class="el" href="structin__space.html">in_space</a></dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a id="letter_N" name="letter_N">N</a></dt>
<dd><a class="el" href="structnovas__delaunay__args.html">novas_delaunay_args</a></dd><dd><a class="el" href="structnovas__frame.html">novas_frame</a></dd><dd><a class="el" href="structnovas__matrix.html">novas_matrix</a></dd><dd><a class="el" href="structnovas__planet__bundle.html">novas_planet_bundle</a></dd><dd><a class="el" href="structnovas__timespec.html">novas_timespec</a></dd><dd><a class="el" href="structnovas__transform.html">novas_transform</a></dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a id="letter_O" name="letter_O">O</a></dt>
<dd><a class="el" href="structobject.html">object</a></dd><dd><a class="el" href="structobserver.html">observer</a></dd><dd><a class="el" href="structon__surface.html">on_surface</a></dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a id="letter_R" name="letter_R">R</a></dt>
<dd><a class="el" href="structra__of__cio.html">ra_of_cio</a></dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a id="letter_S" name="letter_S">S</a></dt>
<dd><a class="el" href="structsky__pos.html">sky_pos</a></dd></dl>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
Expand Down
Loading

0 comments on commit c891f93

Please sign in to comment.