42 lines
1.7 KiB
HTML
42 lines
1.7 KiB
HTML
<!DOCTYPE html>
|
|
<!--
|
|
Copyright (C) 2018-2020 Andreas Gustafsson. This file is part of
|
|
the Gaborator library source distribution. See the file LICENSE at
|
|
the top level of the distribution for license information.
|
|
-->
|
|
<html>
|
|
<head>
|
|
<link rel="stylesheet" href="../doc.css" type="text/css" />
|
|
<title>Gaborator reference: API Introdution</title>
|
|
</head>
|
|
<body>
|
|
<h1>Gaborator reference: API Introduction</h1>
|
|
|
|
<p>The public API of the Gaborator library is defined in the HTML
|
|
documentation in the form of annotated C++ declarations. These are
|
|
similar to the actual declarations in the respective header files, but
|
|
simplified for clarity and omitting implementation details.</p>
|
|
|
|
<p>The actual implementation in the header file may be different in a
|
|
number of ways but nonetheless compatible with the documented API.
|
|
For example, classes may be declared using the keyword <code>struct</code>
|
|
rather than <code>class</code>, function parameter names may be
|
|
different, types may be declared using different but equivalent
|
|
typedefs, and functions or templates in the header file may have
|
|
additional arguments with default values. Any classes, functions, and
|
|
other definitions not mentioned in the documentation should be
|
|
considered private and are subject to change or deletion without
|
|
notice.
|
|
</p>
|
|
|
|
<p>All definitions are in the namespace <code>gaborator</code>.
|
|
Applications need to either prefix class names
|
|
with <code>gaborator::</code>, or use <code>using namespace
|
|
gaborator;</code>.
|
|
</p>
|
|
|
|
<div class="nav"><span class="prev"><a href="../synth.html">Previous: Example 5: Synthesis from Scratch</a></span><span class="next"><a href="gaborator_h.html">Next: Spectrum analysis and synthesis: <code>gaborator.h</code></a></span></div>
|
|
|
|
</body>
|
|
</html>
|