official
/
OpenLCP
1
0
Fork 0
Code Releases 1 Activity

documentation cleanup

This commit is contained in:
Kevin Matz 2023-04-25 10:25:54 -04:00
parent 76d3cd00f8
commit c40d1fcdf5
5 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -90,7 +90,7 @@ may not be inherited from sibling `PDU` in the data.
### Dependent Protocols ### Dependent Protocols
| Protocol Name | Standard | Referenced By | Implementation Status | | Protocol Name | Standard | Referenced By | Implementation Status |
| :- | :-: |:-: | :-: | | :- | :-: |:-: | :-: |
| UUID Universally Unique Identifier | RFC 4122 | RLP, DDL | Partial | | Universally Unique Identifier (UUID) | RFC 4122 | RLP, DDL | Partial |
| Service Location Protocol (SLP) | RFC 2609 | EPI 19 | | | Service Location Protocol (SLP) | RFC 2609 | EPI 19 | |
| Trivial File Transfer Protocol (TFTP) | RFC 1350 | EPI 25 | | | Trivial File Transfer Protocol (TFTP) | RFC 1350 | EPI 25 | |
| Network Time Protocol (NTP) | RFC 5909 | OSC | | | Network Time Protocol (NTP) | RFC 5909 | OSC | |

2
docs/Doxyfile.in
View File

@ -5,7 +5,7 @@
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8 DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = OpenLCP PROJECT_NAME = OpenLCP
PROJECT_NUMBER = 0.2.0 PROJECT_NUMBER = @PROJECT_VERSION@
#PROJECT_BRIEF = "A collection of C++ libraries for Lighting Control Protocols, focusing on ESTA sponsored ANSI standards." #PROJECT_BRIEF = "A collection of C++ libraries for Lighting Control Protocols, focusing on ESTA sponsored ANSI standards."
PROJECT_LOGO = PROJECT_LOGO =
OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/docs OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/docs

6
docs/doxygen_files/footer.html
View File

@ -1,17 +1,15 @@
<!-- HTML footer for doxygen 1.9.1-->
<!-- start footer part -->
<!--BEGIN GENERATE_TREEVIEW--> <!--BEGIN GENERATE_TREEVIEW-->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
$navpath $navpath
<li class="footer">Copyright &copy; 2020,2021 Kevin Matz -- Generated by doxygen $doxygenversion</li> <li class="footer">Copyright &copy; 2020-2023 Kevin Matz -- Generated by doxygen $doxygenversion</li>
</ul> </ul>
</div> </div>
<!--END GENERATE_TREEVIEW--> <!--END GENERATE_TREEVIEW-->
<!--BEGIN !GENERATE_TREEVIEW--> <!--BEGIN !GENERATE_TREEVIEW-->
<address class="footer"> <address class="footer">
<small> <small>
Copyright &copy; 2020,2021 Kevin Matz -- Generated by doxygen $doxygenversion Copyright &copy; 2020-2023 Kevin Matz -- Generated by doxygen $doxygenversion
</small> </small>
</address> </address>
<!--END !GENERATE_TREEVIEW--> <!--END !GENERATE_TREEVIEW-->

6
protocol/osc/receiver.cpp
View File

@ -109,7 +109,7 @@ void Receiver::scheduleBundle(const std::shared_ptr<Bundle> msg) const
/** /**
* @brief Receiver::rxPacket * @brief Receiver::rxPacket
* @param stream * @param buffer
*/ */
void Receiver::rxPacket(std::shared_ptr<bufferstream> buffer) const void Receiver::rxPacket(std::shared_ptr<bufferstream> buffer) const
{ {
@ -124,7 +124,7 @@ void Receiver::rxPacket(std::shared_ptr<bufferstream> buffer) const
/** /**
* @brief Receiver::rxPacketTCP * @brief Receiver::rxPacketTCP
* @param stream * @param buffer
* *
* This method is presented in \cite Spec10 Spec 1.0, but has been delared as legacy * This method is presented in \cite Spec10 Spec 1.0, but has been delared as legacy
* in favor SLIP framming. * in favor SLIP framming.
@ -148,7 +148,7 @@ void Receiver::rxPacketTCP(std::shared_ptr<bufferstream> buffer) const
/** /**
* @brief Receiver::rxPacketSLIP * @brief Receiver::rxPacketSLIP
* @param stream * @param buffer
*/ */
void Receiver::rxPacketSLIP(std::shared_ptr<bufferstream> buffer) const void Receiver::rxPacketSLIP(std::shared_ptr<bufferstream> buffer) const
{ {

10
protocol/osc/receiver.h
View File

@ -42,13 +42,13 @@ public:
explicit Receiver(); explicit Receiver();
virtual ~Receiver(); virtual ~Receiver();
void dispatch(const std::shared_ptr<Message>) const; void dispatch(const std::shared_ptr<Message> msg) const;
protected: protected:
void scheduleBundle(const std::shared_ptr<Bundle>) const; void scheduleBundle(const std::shared_ptr<Bundle> bundle) const;
void rxPacketUDP(std::shared_ptr<bufferstream>) const; void rxPacket(std::shared_ptr<bufferstream> buffer) const;
void rxPacketTCP(std::shared_ptr<bufferstream>) const; void rxPacketTCP(std::shared_ptr<bufferstream> buffer) const;
void rxPacketSLIP(std::shared_ptr<bufferstream>) const; void rxPacketSLIP(std::shared_ptr<bufferstream> buffer) const;
/** /**
* @brief rootMethod * @brief rootMethod