Skip to content

Commit

Permalink
Updated the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Jul 24, 2023
1 parent e79145b commit 8753ce2
Show file tree
Hide file tree
Showing 28 changed files with 592 additions and 153 deletions.
6 changes: 3 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>VGamepad PC: &lt;a href=&quot;https://github.com/kitswas/VirtualGamePad-PC&quot; &gt;VirtualGamePad Server&lt;/a&gt;</title>
<title>VGamepad PC: VirtualGamePad Server</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 Down Expand Up @@ -110,7 +110,7 @@
</div>

<div><div class="header">
<div class="headertitle"><div class="title"><a href="https://github.com/kitswas/VirtualGamePad-PC">VirtualGamePad Server</a> </div></div>
<div class="headertitle"><div class="title">VirtualGamePad <a class="el" href="classServer.html">Server</a> </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="md_README"></a> This is a part of <a href="https://kitswas.github.io/VirtualGamePad/">the VirtualGamePad project</a>.</p>
Expand Down Expand Up @@ -157,7 +157,7 @@ <h2><a class="anchor" id="generating-documentation"></a>
You can generate the documentation by running the following command:</p>
<div class="fragment"><div class="line">doxygen Doxyfile</div>
</div><!-- fragment --><p>This repository has automated workflow via Github Actions. <br />
Documentation is auto-generated and deployed to <a href="https://kitswas.github.io/CPP-project-template/">Github Pages</a>. <br />
Documentation is auto-generated and deployed to Github Pages. <br />
Disable Actions on your own copy or delete the <a href="./.github/workflows">workflows</a> folder if you do not want to be billed. This is <b>not my responsiblity.</b> </p>
</div></div><!-- PageDoc -->
</div><!-- contents -->
Expand Down
2 changes: 1 addition & 1 deletion docs/navtreedata.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
var NAVTREE =
[
[ "VGamepad PC", "index.html", [
[ "<a href=\"https://github.com/kitswas/VirtualGamePad-PC\" >VirtualGamePad Server</a>", "index.html", "index" ],
[ "VirtualGamePad Server", "index.html", "index" ],
[ "Namespaces", "namespaces.html", [
[ "Namespace List", "namespaces.html", "namespaces_dup" ]
] ],
Expand Down
3 changes: 2 additions & 1 deletion docs/search/all_0.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
var searchData=
[
['_3ca_20href_3d_22https_3a_2f_2fgithub_2ecom_2fkitswas_2fvirtualgamepad_2dpc_22_20_3evirtualgamepad_20server_3c_2fa_3e_0',['&lt;a href=&quot;https://github.com/kitswas/VirtualGamePad-PC&quot; &gt;VirtualGamePad Server&lt;/a&gt;',['../index.html',1,'']]]
['alphanumeric_0',['ALPHANUMERIC',['../classqrcodegen_1_1QrSegment_1_1Mode.html#a634cb6ed8e419774219ea84ad9518506',1,'qrcodegen::QrSegment::Mode']]],
['appendbits_1',['appendBits',['../classqrcodegen_1_1BitBuffer.html#abeaf5adf83b987fa573c63a1ffad30ad',1,'qrcodegen::BitBuffer']]]
];
7 changes: 5 additions & 2 deletions docs/search/all_1.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
var searchData=
[
['alphanumeric_0',['ALPHANUMERIC',['../classqrcodegen_1_1QrSegment_1_1Mode.html#a634cb6ed8e419774219ea84ad9518506',1,'qrcodegen::QrSegment::Mode']]],
['appendbits_1',['appendBits',['../classqrcodegen_1_1BitBuffer.html#abeaf5adf83b987fa573c63a1ffad30ad',1,'qrcodegen::BitBuffer']]]
['bitbuffer_0',['BitBuffer',['../classqrcodegen_1_1BitBuffer.html#a22035f0be00f4d956574107fc3bad801',1,'qrcodegen::BitBuffer::BitBuffer()'],['../classqrcodegen_1_1BitBuffer.html',1,'qrcodegen::BitBuffer']]],
['blockexternalinput_1',['blockExternalInput',['../simulate_8cpp.html#a1a58e26f8828e79914ba9684c425e706',1,'blockExternalInput():&#160;simulate.cpp'],['../simulate_8hpp.html#a1a58e26f8828e79914ba9684c425e706',1,'blockExternalInput():&#160;simulate.cpp']]],
['buttons_5fdown_2',['buttons_down',['../structvgp__data__exchange__gamepad__reading.html#a5792c5ee458cfd3a0073a0b04bf631b2',1,'vgp_data_exchange_gamepad_reading']]],
['buttons_5fup_3',['buttons_up',['../structvgp__data__exchange__gamepad__reading.html#a91b14d6db688cca592cb98248ee779dd',1,'vgp_data_exchange_gamepad_reading']]],
['byte_4',['BYTE',['../classqrcodegen_1_1QrSegment_1_1Mode.html#a2b7f9fa8b41b8818f006ef9a089912fa',1,'qrcodegen::QrSegment::Mode']]]
];
17 changes: 8 additions & 9 deletions docs/search/all_10.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
var searchData=
[
['readme_2emd_0',['README.MD',['../README_8MD.html',1,'']]],
['right_5fthumbstick_5fx_1',['right_thumbstick_x',['../structvgp__data__exchange__gamepad__reading.html#ac53ae1338cd7518e1bac31cde12f17c2',1,'vgp_data_exchange_gamepad_reading']]],
['right_5fthumbstick_5fy_2',['right_thumbstick_y',['../structvgp__data__exchange__gamepad__reading.html#abc3ed3d3801cb8fdd33491d4a0334650',1,'vgp_data_exchange_gamepad_reading']]],
['right_5ftrigger_3',['right_trigger',['../structvgp__data__exchange__gamepad__reading.html#a6604222d754dd7a62d480631eea4ccfb',1,'vgp_data_exchange_gamepad_reading']]],
['rightclick_4',['rightClick',['../mouseSim_8cpp.html#a4ddf589c93373e6160864e8eb50840f0',1,'rightClick():&#160;mouseSim.cpp'],['../mouseSim_8hpp.html#a4ddf589c93373e6160864e8eb50840f0',1,'rightClick():&#160;mouseSim.cpp']]],
['rightthumbstickdown_5',['RightThumbstickDown',['../executor_8hpp.html#acff7359988434d5375eab1c1ae2a5221a4b86b547774a6284c300917895d6d2d8',1,'executor.hpp']]],
['rightthumbstickleft_6',['RightThumbstickLeft',['../executor_8hpp.html#acff7359988434d5375eab1c1ae2a5221afecb8c31cef78e5bf2e6bbc76161b9e8',1,'executor.hpp']]],
['rightthumbstickright_7',['RightThumbstickRight',['../executor_8hpp.html#acff7359988434d5375eab1c1ae2a5221ac8d6594aa9c077b48eb0f4a278146e71',1,'executor.hpp']]],
['rightthumbstickup_8',['RightThumbstickUp',['../executor_8hpp.html#acff7359988434d5375eab1c1ae2a5221a0cbcfd3105046b44a6bc5f5d0dbd648f',1,'executor.hpp']]]
['scrolldown_0',['scrollDown',['../mouseSim_8cpp.html#a6eb4003bee673b00188d2ff04717c3e0',1,'scrollDown():&#160;mouseSim.cpp'],['../mouseSim_8hpp.html#a6eb4003bee673b00188d2ff04717c3e0',1,'scrollDown():&#160;mouseSim.cpp']]],
['scrollup_1',['scrollUp',['../mouseSim_8cpp.html#a5cb5135b6111e4f91dacba76b8a71d40',1,'scrollUp():&#160;mouseSim.cpp'],['../mouseSim_8hpp.html#a5cb5135b6111e4f91dacba76b8a71d40',1,'scrollUp():&#160;mouseSim.cpp']]],
['server_2',['Server',['../classServer.html',1,'Server'],['../classServer.html#aa19a9ff43459f5d6f49ef16587ccd290',1,'Server::Server()']]],
['server_2ecpp_3',['server.cpp',['../server_8cpp.html',1,'']]],
['server_2ehpp_4',['server.hpp',['../server_8hpp.html',1,'']]],
['simulate_2ecpp_5',['simulate.cpp',['../simulate_8cpp.html',1,'']]],
['simulate_2ehpp_6',['simulate.hpp',['../simulate_8hpp.html',1,'']]],
['singleclick_7',['singleClick',['../mouseSim_8cpp.html#adb7fe4652e0eb96a9523318e89ac5284',1,'singleClick():&#160;mouseSim.cpp'],['../mouseSim_8hpp.html#adb7fe4652e0eb96a9523318e89ac5284',1,'singleClick():&#160;mouseSim.cpp']]]
];
13 changes: 5 additions & 8 deletions docs/search/all_11.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
var searchData=
[
['scrolldown_0',['scrollDown',['../mouseSim_8cpp.html#a6eb4003bee673b00188d2ff04717c3e0',1,'scrollDown():&#160;mouseSim.cpp'],['../mouseSim_8hpp.html#a6eb4003bee673b00188d2ff04717c3e0',1,'scrollDown():&#160;mouseSim.cpp']]],
['scrollup_1',['scrollUp',['../mouseSim_8cpp.html#a5cb5135b6111e4f91dacba76b8a71d40',1,'scrollUp():&#160;mouseSim.cpp'],['../mouseSim_8hpp.html#a5cb5135b6111e4f91dacba76b8a71d40',1,'scrollUp():&#160;mouseSim.cpp']]],
['server_2',['Server',['../classServer.html',1,'Server'],['../classServer.html#aa19a9ff43459f5d6f49ef16587ccd290',1,'Server::Server()']]],
['server_2ecpp_3',['server.cpp',['../server_8cpp.html',1,'']]],
['server_2ehpp_4',['server.hpp',['../server_8hpp.html',1,'']]],
['simulate_2ecpp_5',['simulate.cpp',['../simulate_8cpp.html',1,'']]],
['simulate_2ehpp_6',['simulate.hpp',['../simulate_8hpp.html',1,'']]],
['singleclick_7',['singleClick',['../mouseSim_8cpp.html#adb7fe4652e0eb96a9523318e89ac5284',1,'singleClick():&#160;mouseSim.cpp'],['../mouseSim_8hpp.html#adb7fe4652e0eb96a9523318e89ac5284',1,'singleClick():&#160;mouseSim.cpp']]]
['tcpserver_0',['tcpServer',['../classServer.html#adf90e9ec05e1c353fb792f78daae2da3',1,'Server']]],
['threshold_1',['THRESHOLD',['../executor_8cpp.html#a4679d8ea8690999a6c6c7c0cb245c879',1,'executor.cpp']]],
['thumbstick_2',['Thumbstick',['../executor_8hpp.html#acff7359988434d5375eab1c1ae2a5221',1,'executor.hpp']]],
['thumbstick_5fkeys_3',['THUMBSTICK_KEYS',['../executor_8hpp.html#a20f9a68ec08c7b776409942f1fa3afda',1,'executor.hpp']]],
['typeunicodestring_4',['typeUnicodeString',['../keyboardSim_8cpp.html#a156ffe36d7691f5734e28be482f26427',1,'typeUnicodeString(std::wstring str):&#160;keyboardSim.cpp'],['../keyboardSim_8hpp.html#a156ffe36d7691f5734e28be482f26427',1,'typeUnicodeString(std::wstring str):&#160;keyboardSim.cpp']]]
];
8 changes: 3 additions & 5 deletions docs/search/all_12.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
var searchData=
[
['tcpserver_0',['tcpServer',['../classServer.html#adf90e9ec05e1c353fb792f78daae2da3',1,'Server']]],
['threshold_1',['THRESHOLD',['../executor_8cpp.html#a4679d8ea8690999a6c6c7c0cb245c879',1,'executor.cpp']]],
['thumbstick_2',['Thumbstick',['../executor_8hpp.html#acff7359988434d5375eab1c1ae2a5221',1,'executor.hpp']]],
['thumbstick_5fkeys_3',['THUMBSTICK_KEYS',['../executor_8hpp.html#a20f9a68ec08c7b776409942f1fa3afda',1,'executor.hpp']]],
['typeunicodestring_4',['typeUnicodeString',['../keyboardSim_8cpp.html#a156ffe36d7691f5734e28be482f26427',1,'typeUnicodeString(std::wstring str):&#160;keyboardSim.cpp'],['../keyboardSim_8hpp.html#a156ffe36d7691f5734e28be482f26427',1,'typeUnicodeString(std::wstring str):&#160;keyboardSim.cpp']]]
['ui_0',['Ui',['../namespaceUi.html',1,'']]],
['unblockexternalinput_1',['unblockExternalInput',['../simulate_8cpp.html#afe5be32b0cd225ebd4d32a53ed7b9246',1,'unblockExternalInput():&#160;simulate.cpp'],['../simulate_8hpp.html#afe5be32b0cd225ebd4d32a53ed7b9246',1,'unblockExternalInput():&#160;simulate.cpp']]],
['utf8_2',['utf8',['../structcolfer__text.html#a27f97020de33ac27e8f30f0ae887753c',1,'colfer_text']]]
];
12 changes: 9 additions & 3 deletions docs/search/all_13.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 1 addition & 8 deletions docs/search/all_14.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
var searchData=
[
['vgp_5fdata_5fexchange_5fgamepad_5freading_0',['vgp_data_exchange_gamepad_reading',['../structvgp__data__exchange__gamepad__reading.html',1,'vgp_data_exchange_gamepad_reading'],['../Colfer_8h.html#a4ea6bae9aa1be7083dad3556c769fe90',1,'vgp_data_exchange_gamepad_reading:&#160;Colfer.h']]],
['vgp_5fdata_5fexchange_5fgamepad_5freading_5fmarshal_1',['vgp_data_exchange_gamepad_reading_marshal',['../Colfer_8c.html#ad1eb2a61a617c3f472435a7f48fc3f5b',1,'vgp_data_exchange_gamepad_reading_marshal(const vgp_data_exchange_gamepad_reading *o, void *buf):&#160;Colfer.c'],['../Colfer_8h.html#ad1eb2a61a617c3f472435a7f48fc3f5b',1,'vgp_data_exchange_gamepad_reading_marshal(const vgp_data_exchange_gamepad_reading *o, void *buf):&#160;Colfer.c']]],
['vgp_5fdata_5fexchange_5fgamepad_5freading_5fmarshal_5flen_2',['vgp_data_exchange_gamepad_reading_marshal_len',['../Colfer_8c.html#a63391a69d249ab3a870053efd32e3519',1,'vgp_data_exchange_gamepad_reading_marshal_len(const vgp_data_exchange_gamepad_reading *o):&#160;Colfer.c'],['../Colfer_8h.html#a63391a69d249ab3a870053efd32e3519',1,'vgp_data_exchange_gamepad_reading_marshal_len(const vgp_data_exchange_gamepad_reading *o):&#160;Colfer.c']]],
['vgp_5fdata_5fexchange_5fgamepad_5freading_5funmarshal_3',['vgp_data_exchange_gamepad_reading_unmarshal',['../Colfer_8c.html#ab130eb93aed2f467ea03c0ccc29d2828',1,'vgp_data_exchange_gamepad_reading_unmarshal(vgp_data_exchange_gamepad_reading *o, const void *data, size_t datalen):&#160;Colfer.c'],['../Colfer_8h.html#ab130eb93aed2f467ea03c0ccc29d2828',1,'vgp_data_exchange_gamepad_reading_unmarshal(vgp_data_exchange_gamepad_reading *o, const void *data, size_t datalen):&#160;Colfer.c']]],
['vgp_5fdata_5fexchange_5fmessage_4',['vgp_data_exchange_message',['../structvgp__data__exchange__message.html',1,'vgp_data_exchange_message'],['../Colfer_8h.html#ab927a61f6e575c920bd172fc241acb2a',1,'vgp_data_exchange_message:&#160;Colfer.h']]],
['vgp_5fdata_5fexchange_5fmessage_5fmarshal_5',['vgp_data_exchange_message_marshal',['../Colfer_8c.html#a9eb8c3653a4b700ded43e97e8203418c',1,'vgp_data_exchange_message_marshal(const vgp_data_exchange_message *o, void *buf):&#160;Colfer.c'],['../Colfer_8h.html#a9eb8c3653a4b700ded43e97e8203418c',1,'vgp_data_exchange_message_marshal(const vgp_data_exchange_message *o, void *buf):&#160;Colfer.c']]],
['vgp_5fdata_5fexchange_5fmessage_5fmarshal_5flen_6',['vgp_data_exchange_message_marshal_len',['../Colfer_8c.html#ad49b66fa5d5763be56f77398d40e21ff',1,'vgp_data_exchange_message_marshal_len(const vgp_data_exchange_message *o):&#160;Colfer.c'],['../Colfer_8h.html#ad49b66fa5d5763be56f77398d40e21ff',1,'vgp_data_exchange_message_marshal_len(const vgp_data_exchange_message *o):&#160;Colfer.c']]],
['vgp_5fdata_5fexchange_5fmessage_5funmarshal_7',['vgp_data_exchange_message_unmarshal',['../Colfer_8c.html#a93971f646a5b42144f47256abfd36356',1,'vgp_data_exchange_message_unmarshal(vgp_data_exchange_message *o, const void *data, size_t datalen):&#160;Colfer.c'],['../Colfer_8h.html#a93971f646a5b42144f47256abfd36356',1,'vgp_data_exchange_message_unmarshal(vgp_data_exchange_message *o, const void *data, size_t datalen):&#160;Colfer.c']]]
['win32_5flean_5fand_5fmean_0',['WIN32_LEAN_AND_MEAN',['../keyboardSim_8hpp.html#ac7bef5d85e3dcd73eef56ad39ffc84a9',1,'WIN32_LEAN_AND_MEAN:&#160;keyboardSim.hpp'],['../mouseSim_8hpp.html#ac7bef5d85e3dcd73eef56ad39ffc84a9',1,'WIN32_LEAN_AND_MEAN:&#160;mouseSim.hpp']]]
];
3 changes: 2 additions & 1 deletion docs/search/all_15.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
var searchData=
[
['win32_5flean_5fand_5fmean_0',['WIN32_LEAN_AND_MEAN',['../keyboardSim_8hpp.html#ac7bef5d85e3dcd73eef56ad39ffc84a9',1,'WIN32_LEAN_AND_MEAN:&#160;keyboardSim.hpp'],['../mouseSim_8hpp.html#ac7bef5d85e3dcd73eef56ad39ffc84a9',1,'WIN32_LEAN_AND_MEAN:&#160;mouseSim.hpp']]]
['_7emainwindow_0',['~MainWindow',['../classMainWindow.html#ae98d00a93bc118200eeef9f9bba1dba7',1,'MainWindow']]],
['_7eserver_1',['~Server',['../classServer.html#a4b3aa2579cb1c8cd1d069582c14d0fa6',1,'Server']]]
];
5 changes: 0 additions & 5 deletions docs/search/all_16.js

This file was deleted.

14 changes: 9 additions & 5 deletions docs/search/all_2.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
var searchData=
[
['bitbuffer_0',['BitBuffer',['../classqrcodegen_1_1BitBuffer.html#a22035f0be00f4d956574107fc3bad801',1,'qrcodegen::BitBuffer::BitBuffer()'],['../classqrcodegen_1_1BitBuffer.html',1,'qrcodegen::BitBuffer']]],
['blockexternalinput_1',['blockExternalInput',['../simulate_8cpp.html#a1a58e26f8828e79914ba9684c425e706',1,'blockExternalInput():&#160;simulate.cpp'],['../simulate_8hpp.html#a1a58e26f8828e79914ba9684c425e706',1,'blockExternalInput():&#160;simulate.cpp']]],
['buttons_5fdown_2',['buttons_down',['../structvgp__data__exchange__gamepad__reading.html#a5792c5ee458cfd3a0073a0b04bf631b2',1,'vgp_data_exchange_gamepad_reading']]],
['buttons_5fup_3',['buttons_up',['../structvgp__data__exchange__gamepad__reading.html#a91b14d6db688cca592cb98248ee779dd',1,'vgp_data_exchange_gamepad_reading']]],
['byte_4',['BYTE',['../classqrcodegen_1_1QrSegment_1_1Mode.html#a2b7f9fa8b41b8818f006ef9a089912fa',1,'qrcodegen::QrSegment::Mode']]]
['clearexistinginput_0',['clearExistingInput',['../simulate_8cpp.html#a441af9012ae77eec7d0203eead49e29c',1,'clearExistingInput():&#160;simulate.cpp'],['../simulate_8hpp.html#a441af9012ae77eec7d0203eead49e29c',1,'clearExistingInput():&#160;simulate.cpp']]],
['colfer_2ec_1',['Colfer.c',['../Colfer_8c.html',1,'']]],
['colfer_2eh_2',['Colfer.h',['../Colfer_8h.html',1,'']]],
['colfer_5fbinary_3',['colfer_binary',['../structcolfer__binary.html',1,'']]],
['colfer_5flist_5fmax_4',['colfer_list_max',['../Colfer_8c.html#aa21093afece436eb3e6bef2f47b41cd6',1,'colfer_list_max:&#160;Colfer.c'],['../Colfer_8h.html#aa21093afece436eb3e6bef2f47b41cd6',1,'colfer_list_max:&#160;Colfer.c']]],
['colfer_5fsize_5fmax_5',['colfer_size_max',['../Colfer_8c.html#aaedb2848ff1ebabde5cfa183273dee78',1,'colfer_size_max:&#160;Colfer.c'],['../Colfer_8h.html#aaedb2848ff1ebabde5cfa183273dee78',1,'colfer_size_max:&#160;Colfer.c']]],
['colfer_5ftext_6',['colfer_text',['../structcolfer__text.html',1,'']]],
['contents_7',['contents',['../structvgp__data__exchange__message.html#aa32c9f97d36ed357502fee1c252ae491',1,'vgp_data_exchange_message']]],
['createqr_8',['createQR',['../server_8cpp.html#ad5d191a059f8291160d639a7105d940d',1,'server.cpp']]]
];
Loading

0 comments on commit 8753ce2

Please sign in to comment.