From 3af5da9d3e4394aff60d3b760a60eeb4d60c5046 Mon Sep 17 00:00:00 2001 From: Tobi-D7 Date: Sat, 24 Jul 2021 22:02:52 +0000 Subject: [PATCH] Documentation1 --- main/doc/html/classsound-members.html | 5 +-- main/doc/html/classsound.html | 44 +++++++++++++++++++++++---- main/doc/html/classsound.js | 1 + main/doc/html/functions_func_s.html | 5 ++- main/doc/html/functions_s.html | 7 +++-- main/doc/html/navtreedata.js | 2 +- main/doc/html/navtreeindex1.js | 16 +++++----- main/doc/html/navtreeindex2.js | 1 + 8 files changed, 61 insertions(+), 20 deletions(-) diff --git a/main/doc/html/classsound-members.html b/main/doc/html/classsound-members.html index 5c28c77..da0369d 100644 --- a/main/doc/html/classsound-members.html +++ b/main/doc/html/classsound-members.html @@ -58,8 +58,9 @@ $(document).ready(function(){initNavTree('classsound.html',''); initResizable();

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

- - + + +
play()sound
stop()sound
~sound()sound
sound(const std::string &path, int channel=1, bool toloop=false)sound
stop()sound
~sound()sound
diff --git a/main/doc/html/classsound.html b/main/doc/html/classsound.html index bd061c4..d2809fc 100644 --- a/main/doc/html/classsound.html +++ b/main/doc/html/classsound.html @@ -62,6 +62,8 @@ $(document).ready(function(){initNavTree('classsound.html',''); initResizable(); + + @@ -72,6 +74,41 @@ Public Member Functions

Detailed Description

Sound Class

Constructor & Destructor Documentation

+ +

◆ sound()

+ +
+
+

Public Member Functions

 sound (const std::string &path, int channel=1, bool toloop=false)
 
 ~sound ()
 
void play ()
+ + + + + + + + + + + + + + + + + + + + + + + +
sound::sound (const std::string & path,
int channel = 1,
bool toloop = false 
)
+
+

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

+ +
+

◆ ~sound()

@@ -86,12 +123,7 @@ Public Member Functions
-
 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

+

deconstruct the sound

diff --git a/main/doc/html/classsound.js b/main/doc/html/classsound.js index 356e7fb..daafbd7 100644 --- a/main/doc/html/classsound.js +++ b/main/doc/html/classsound.js @@ -1,5 +1,6 @@ var classsound = [ + [ "sound", "classsound.html#a2f69382c0ac7e2aa90d8278cc5b6bd70", null ], [ "~sound", "classsound.html#a4a82f1972ceb6a2642bb2dcc067c3d72", null ], [ "play", "classsound.html#abb2c33709eb822528889e32722fc1153", null ], [ "stop", "classsound.html#adf45b194f1b8bcbaca3ee6eec0ecc71a", null ] diff --git a/main/doc/html/functions_func_s.html b/main/doc/html/functions_func_s.html index 1f85e17..354cbac 100644 --- a/main/doc/html/functions_func_s.html +++ b/main/doc/html/functions_func_s.html @@ -84,6 +84,9 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza
  • skip_bom() : nlohmann::detail::lexer< BasicJsonType, InputAdapterType >
    • +
  • sound() +: sound +
  • split() : nlohmann::json_pointer< BasicJsonType >
    • @@ -103,7 +106,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_s.html b/main/doc/html/functions_s.html index ccdf27f..9dc6f35 100644 --- a/main/doc/html/functions_s.html +++ b/main/doc/html/functions_s.html @@ -90,6 +90,9 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable()
  • skip_bom() : nlohmann::detail::lexer< BasicJsonType, InputAdapterType >
    • +
  • sound() +: sound +
  • split() : nlohmann::json_pointer< BasicJsonType >
    • @@ -112,8 +115,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/navtreedata.js b/main/doc/html/navtreedata.js index cd32465..746f973 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#a5c53878cf08d463eb4e7ca0270532572" +"structnlohmann_1_1json__sax.html#a38c2dbde07138cc436ea7fbf22c1e92d" ]; var SYNCONMSG = 'click to disable panel synchronisation'; diff --git a/main/doc/html/navtreeindex1.js b/main/doc/html/navtreeindex1.js index 6581a93..3dc9d53 100644 --- a/main/doc/html/navtreeindex1.js +++ b/main/doc/html/navtreeindex1.js @@ -164,12 +164,13 @@ var NAVTREEINDEX1 = "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], +"classsound.html#a2f69382c0ac7e2aa90d8278cc5b6bd70":[2,0,3,0], +"classsound.html#a4a82f1972ceb6a2642bb2dcc067c3d72":[2,0,3,1], +"classsound.html#abb2c33709eb822528889e32722fc1153":[2,0,3,2], +"classsound.html#adf45b194f1b8bcbaca3ee6eec0ecc71a":[2,0,3,3], "deprecated.html":[0], -"functions.html":[2,3,0,0], "functions.html":[2,3,0], +"functions.html":[2,3,0,0], "functions_b.html":[2,3,0,1], "functions_c.html":[2,3,0,2], "functions_d.html":[2,3,0,3], @@ -225,10 +226,10 @@ var NAVTREEINDEX1 = "namespacemembers_enum.html":[1,1,3], "namespacemembers_func.html":[1,1,1], "namespacemembers_type.html":[1,1,2], -"namespacenlohmann.html":[1,0,0], "namespacenlohmann.html":[2,0,0], -"namespacenlohmann_1_1detail.html":[2,0,0,0], +"namespacenlohmann.html":[1,0,0], "namespacenlohmann_1_1detail.html":[1,0,0,0], +"namespacenlohmann_1_1detail.html":[2,0,0,0], "namespacenlohmann_1_1detail_1_1dtoa__impl.html":[1,0,0,0,0], "namespaces.html":[1,0], "pages.html":[], @@ -248,6 +249,5 @@ var NAVTREEINDEX1 = "structnlohmann_1_1json__sax.html#a07eab82f6c82d606787eee9ad73d2bda":[2,0,0,5,5], "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#a2e0c7ecd80b18d18a8cc76f71cfc2028":[2,0,0,5,8] }; diff --git a/main/doc/html/navtreeindex2.js b/main/doc/html/navtreeindex2.js index 043e546..579bc34 100644 --- a/main/doc/html/navtreeindex2.js +++ b/main/doc/html/navtreeindex2.js @@ -1,5 +1,6 @@ var NAVTREEINDEX2 = { +"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],