From e42d1ec20afe21d9c6e26ece04e2ffad5bd6211f Mon Sep 17 00:00:00 2001 From: Tobi-D7 Date: Sat, 24 Jul 2021 21:59:50 +0000 Subject: [PATCH] Documentation1 --- main/doc/html/annotated.html | 1 + main/doc/html/annotated_dup.js | 3 +- main/doc/html/classes.html | 9 +- main/doc/html/classsound-members.html | 74 +++++++++++++ main/doc/html/classsound.html | 147 ++++++++++++++++++++++++++ main/doc/html/classsound.js | 6 ++ main/doc/html/functions_func_p.html | 5 +- main/doc/html/functions_func_s.html | 5 +- main/doc/html/functions_func_~.html | 3 + main/doc/html/functions_p.html | 5 +- main/doc/html/functions_s.html | 7 +- main/doc/html/functions_~.html | 3 + main/doc/html/hierarchy.html | 1 + main/doc/html/hierarchy.js | 3 +- main/doc/html/navtreedata.js | 2 +- main/doc/html/navtreeindex1.js | 12 +-- main/doc/html/navtreeindex2.js | 4 + 17 files changed, 272 insertions(+), 18 deletions(-) create mode 100644 main/doc/html/classsound-members.html create mode 100644 main/doc/html/classsound.html create mode 100644 main/doc/html/classsound.js diff --git a/main/doc/html/annotated.html b/main/doc/html/annotated.html index 38f1f22..2096109 100644 --- a/main/doc/html/annotated.html +++ b/main/doc/html/annotated.html @@ -92,6 +92,7 @@ $(document).ready(function(){initNavTree('annotated.html',''); initResizable();  ▼Nstd  Chash< nlohmann::json >Hash value for JSON objects  Cless<::nlohmann::detail::value_t > + Csound diff --git a/main/doc/html/annotated_dup.js b/main/doc/html/annotated_dup.js index e58274d..474ea5f 100644 --- a/main/doc/html/annotated_dup.js +++ b/main/doc/html/annotated_dup.js @@ -7,5 +7,6 @@ var annotated_dup = [ "std", null, [ [ "hash< nlohmann::json >", "structstd_1_1hash_3_01nlohmann_1_1json_01_4.html", "structstd_1_1hash_3_01nlohmann_1_1json_01_4" ], [ "less<::nlohmann::detail::value_t >", "structstd_1_1less_3_1_1nlohmann_1_1detail_1_1value__t_01_4.html", "structstd_1_1less_3_1_1nlohmann_1_1detail_1_1value__t_01_4" ] - ] ] + ] ], + [ "sound", "classsound.html", "classsound" ] ]; \ No newline at end of file diff --git a/main/doc/html/classes.html b/main/doc/html/classes.html index b7ef81b..69f6691 100644 --- a/main/doc/html/classes.html +++ b/main/doc/html/classes.html @@ -90,26 +90,27 @@ $(document).ready(function(){initNavTree('classes.html',''); initResizable(); }) hash< nlohmann::json > (std)    json_sax (nlohmann)    output_adapter_protocol (nlohmann::detail)    -
  t  
- +sound    binary_reader (nlohmann::detail)   
  i  
json_sax_dom_parser (nlohmann::detail)    output_stream_adapter (nlohmann::detail)    +
  t  
+ binary_writer (nlohmann::detail)    basic_json::json_value (nlohmann)    output_string_adapter (nlohmann::detail)    -type_error (nlohmann::detail)    byte_container_with_subtype (nlohmann)    input_stream_adapter (nlohmann::detail)   
  l  
output_vector_adapter (nlohmann::detail)    - +type_error (nlohmann::detail)    +
  e  
internal_iterator (nlohmann::detail)    diff --git a/main/doc/html/classsound-members.html b/main/doc/html/classsound-members.html new file mode 100644 index 0000000..5c28c77 --- /dev/null +++ b/main/doc/html/classsound-members.html @@ -0,0 +1,74 @@ + + + + + + + +Renderd7-nightly: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Renderd7-nightly +  v0.7.0 +
+
+
+ + +
+
+ +
+
+
+ +
+
+
+
sound Member List
+
+
+ +

This is the complete list of members for sound, including all inherited members.

+ + + + +
play()sound
stop()sound
~sound()sound
+
+ + + + diff --git a/main/doc/html/classsound.html b/main/doc/html/classsound.html new file mode 100644 index 0000000..bd061c4 --- /dev/null +++ b/main/doc/html/classsound.html @@ -0,0 +1,147 @@ + + + + + + + +Renderd7-nightly: sound Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Renderd7-nightly +  v0.7.0 +
+
+
+ + +
+
+ +
+
+
+ +
+
+
+Public Member Functions | +List of all members
+
+
sound Class Reference
+
+
+ +

#include <sound.hpp>

+ + + + + + + + +

+Public Member Functions

 ~sound ()
 
void play ()
 
void stop ()
 
+

Detailed Description

+

Sound Class

+

Constructor & Destructor Documentation

+ +

◆ ~sound()

+ +
+
+ + + + + + + +
sound::~sound ()
+
+
 Construct new Soundeffect
+ path: Path to the .wav file
+ channel: the channel 1-23
+ toloop: true:loop the sound, false: don't loop
+"/
+

sound(const std::string& path, int channel = 1, bool toloop = false); /** deconstruct the sound

+ +
+
+

Member Function Documentation

+ +

◆ play()

+ +
+
+ + + + + + + +
void sound::play ()
+
+

play the sound

+ +
+
+ +

◆ stop()

+ +
+
+ + + + + + + +
void sound::stop ()
+
+

stop the sound

+ +
+
+
+
+ + + + diff --git a/main/doc/html/classsound.js b/main/doc/html/classsound.js new file mode 100644 index 0000000..356e7fb --- /dev/null +++ b/main/doc/html/classsound.js @@ -0,0 +1,6 @@ +var classsound = +[ + [ "~sound", "classsound.html#a4a82f1972ceb6a2642bb2dcc067c3d72", null ], + [ "play", "classsound.html#abb2c33709eb822528889e32722fc1153", null ], + [ "stop", "classsound.html#adf45b194f1b8bcbaca3ee6eec0ecc71a", null ] +]; \ No newline at end of file diff --git a/main/doc/html/functions_func_p.html b/main/doc/html/functions_func_p.html index c0102c0..a19a578 100644 --- a/main/doc/html/functions_func_p.html +++ b/main/doc/html/functions_func_p.html @@ -90,12 +90,15 @@ $(document).ready(function(){initNavTree('functions_func_p.html',''); initResiza
  • patch() : nlohmann::basic_json
    • +
  • play() +: sound +
  • pop_back() : nlohmann::json_pointer< BasicJsonType >
  • push_back() : nlohmann::basic_json -, nlohmann::json_pointer< BasicJsonType > +, nlohmann::json_pointer< BasicJsonType >
    • diff --git a/main/doc/html/functions_func_s.html b/main/doc/html/functions_func_s.html index ed2f3da..1f85e17 100644 --- a/main/doc/html/functions_func_s.html +++ b/main/doc/html/functions_func_s.html @@ -93,6 +93,9 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza
  • start_object() : nlohmann::json_sax< BasicJsonType >
    • +
  • stop() +: sound +
  • string() : nlohmann::json_sax< BasicJsonType >
    • @@ -100,7 +103,7 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza : nlohmann::byte_container_with_subtype< BinaryType >
  • swap() -: nlohmann::basic_json +: nlohmann::basic_json
    • diff --git a/main/doc/html/functions_func_~.html b/main/doc/html/functions_func_~.html index e03df74..d904e65 100644 --- a/main/doc/html/functions_func_~.html +++ b/main/doc/html/functions_func_~.html @@ -56,6 +56,9 @@ $(document).ready(function(){initNavTree('functions_func_~.html',''); initResiza
  • ~basic_json() : nlohmann::basic_json
    • +
  • ~sound() +: sound +
    • diff --git a/main/doc/html/functions_p.html b/main/doc/html/functions_p.html index 30a2ad9..d0e47d5 100644 --- a/main/doc/html/functions_p.html +++ b/main/doc/html/functions_p.html @@ -97,6 +97,9 @@ $(document).ready(function(){initNavTree('functions_p.html',''); initResizable()
  • patch() : nlohmann::basic_json
    • +
  • play() +: sound +
  • pointer : nlohmann::basic_json , nlohmann::detail::iter_impl< BasicJsonType > @@ -111,7 +114,7 @@ $(document).ready(function(){initNavTree('functions_p.html',''); initResizable() : nlohmann::detail::internal_iterator< BasicJsonType >
  • push_back() -: nlohmann::basic_json +: nlohmann::basic_json , nlohmann::json_pointer< BasicJsonType >
    • diff --git a/main/doc/html/functions_s.html b/main/doc/html/functions_s.html index 94f6dba..ccdf27f 100644 --- a/main/doc/html/functions_s.html +++ b/main/doc/html/functions_s.html @@ -99,6 +99,9 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable()
  • start_object() : nlohmann::json_sax< BasicJsonType >
    • +
  • stop() +: sound +
  • string : nlohmann::basic_json::json_value , nlohmann::json_sax< BasicJsonType > @@ -109,8 +112,8 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable()
  • subtype() : nlohmann::byte_container_with_subtype< BinaryType >
    • -
  • swap() -: nlohmann::basic_json +
  • swap +: nlohmann::basic_json
    • diff --git a/main/doc/html/functions_~.html b/main/doc/html/functions_~.html index 1134151..efeba10 100644 --- a/main/doc/html/functions_~.html +++ b/main/doc/html/functions_~.html @@ -56,6 +56,9 @@ $(document).ready(function(){initNavTree('functions_~.html',''); initResizable()
  • ~basic_json() : nlohmann::basic_json
    • +
  • ~sound() +: sound +
    • diff --git a/main/doc/html/hierarchy.html b/main/doc/html/hierarchy.html index 0321e69..d050cba 100644 --- a/main/doc/html/hierarchy.html +++ b/main/doc/html/hierarchy.html @@ -89,6 +89,7 @@ $(document).ready(function(){initNavTree('hierarchy.html',''); initResizable();  Cnlohmann::detail::parser< BasicJsonType, InputAdapterType >Syntax analysis  Cnlohmann::detail::position_tStruct to capture the start position of the current token  CRenderD7::Sheet + Csound diff --git a/main/doc/html/hierarchy.js b/main/doc/html/hierarchy.js index b0cd3bd..7707f06 100644 --- a/main/doc/html/hierarchy.js +++ b/main/doc/html/hierarchy.js @@ -34,5 +34,6 @@ var hierarchy = ] ], [ "nlohmann::detail::parser< BasicJsonType, InputAdapterType >", "classnlohmann_1_1detail_1_1parser.html", null ], [ "nlohmann::detail::position_t", "structnlohmann_1_1detail_1_1position__t.html", null ], - [ "RenderD7::Sheet", "classRenderD7_1_1Sheet.html", null ] + [ "RenderD7::Sheet", "classRenderD7_1_1Sheet.html", null ], + [ "sound", "classsound.html", null ] ]; \ No newline at end of file diff --git a/main/doc/html/navtreedata.js b/main/doc/html/navtreedata.js index f1e2f93..cd32465 100644 --- a/main/doc/html/navtreedata.js +++ b/main/doc/html/navtreedata.js @@ -52,7 +52,7 @@ var NAVTREEINDEX = [ ".html", "classnlohmann_1_1detail_1_1binary__writer.html#a048887c907afe39759b777e8c888414c", -"structnlohmann_1_1json__sax.html#ad9b253083e0509923ba195136f49face" +"structnlohmann_1_1json__sax.html#a5c53878cf08d463eb4e7ca0270532572" ]; var SYNCONMSG = 'click to disable panel synchronisation'; diff --git a/main/doc/html/navtreeindex1.js b/main/doc/html/navtreeindex1.js index dc8a763..6581a93 100644 --- a/main/doc/html/navtreeindex1.js +++ b/main/doc/html/navtreeindex1.js @@ -163,6 +163,10 @@ var NAVTREEINDEX1 = "classnlohmann_1_1json__pointer.html#ae9015c658f99cf3d48a8563accc79988":[2,0,0,4,2], "classnlohmann_1_1json__pointer.html#af5a4bc4f82113c271c9a0cd4d3b5f31c":[2,0,0,4,20], "classnlohmann_1_1json__pointer.html#afdaacce1edb7145e0434e014f0e8685a":[2,0,0,4,6], +"classsound.html":[2,0,3], +"classsound.html#a4a82f1972ceb6a2642bb2dcc067c3d72":[2,0,3,0], +"classsound.html#abb2c33709eb822528889e32722fc1153":[2,0,3,1], +"classsound.html#adf45b194f1b8bcbaca3ee6eec0ecc71a":[2,0,3,2], "deprecated.html":[0], "functions.html":[2,3,0,0], "functions.html":[2,3,0], @@ -223,8 +227,8 @@ var NAVTREEINDEX1 = "namespacemembers_type.html":[1,1,2], "namespacenlohmann.html":[1,0,0], "namespacenlohmann.html":[2,0,0], -"namespacenlohmann_1_1detail.html":[1,0,0,0], "namespacenlohmann_1_1detail.html":[2,0,0,0], +"namespacenlohmann_1_1detail.html":[1,0,0,0], "namespacenlohmann_1_1detail_1_1dtoa__impl.html":[1,0,0,0,0], "namespaces.html":[1,0], "pages.html":[], @@ -245,9 +249,5 @@ var NAVTREEINDEX1 = "structnlohmann_1_1json__sax.html#a0ad26edef3f8d530dcec3192bba82df6":[2,0,0,5,0], "structnlohmann_1_1json__sax.html#a235ee975617f28e6a996d1e36a282312":[2,0,0,5,11], "structnlohmann_1_1json__sax.html#a2e0c7ecd80b18d18a8cc76f71cfc2028":[2,0,0,5,8], -"structnlohmann_1_1json__sax.html#a38c2dbde07138cc436ea7fbf22c1e92d":[2,0,0,5,6], -"structnlohmann_1_1json__sax.html#a5c53878cf08d463eb4e7ca0270532572":[2,0,0,5,10], -"structnlohmann_1_1json__sax.html#a60287e3bd85f489e04c83f7e3b76e613":[2,0,0,5,12], -"structnlohmann_1_1json__sax.html#a82ed080814fa656191a537284bb0c575":[2,0,0,5,1], -"structnlohmann_1_1json__sax.html#ad0c722d53ff97be700ccf6a9468bd456":[2,0,0,5,9] +"structnlohmann_1_1json__sax.html#a38c2dbde07138cc436ea7fbf22c1e92d":[2,0,0,5,6] }; diff --git a/main/doc/html/navtreeindex2.js b/main/doc/html/navtreeindex2.js index 94ef3fd..043e546 100644 --- a/main/doc/html/navtreeindex2.js +++ b/main/doc/html/navtreeindex2.js @@ -1,5 +1,9 @@ var NAVTREEINDEX2 = { +"structnlohmann_1_1json__sax.html#a5c53878cf08d463eb4e7ca0270532572":[2,0,0,5,10], +"structnlohmann_1_1json__sax.html#a60287e3bd85f489e04c83f7e3b76e613":[2,0,0,5,12], +"structnlohmann_1_1json__sax.html#a82ed080814fa656191a537284bb0c575":[2,0,0,5,1], +"structnlohmann_1_1json__sax.html#ad0c722d53ff97be700ccf6a9468bd456":[2,0,0,5,9], "structnlohmann_1_1json__sax.html#ad9b253083e0509923ba195136f49face":[2,0,0,5,3], "structnlohmann_1_1json__sax.html#ae7c31614e8a82164d2d7f8dbf4671b25":[2,0,0,5,4], "structnlohmann_1_1json__sax.html#affa7a78b8e9cc9cc3ac99927143142a5":[2,0,0,5,2],