Skip to content

Commit 2951046

Browse files
committed
add doxygen mainpage
1 parent c673e3b commit 2951046

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -333,3 +333,5 @@ CATKIN_IGNORE
333333
.history
334334

335335
# End of https://www.gitignore.io/api/ros,c++,linux,macos,python,pycharm,visualstudiocode
336+
337+
!doc/mainpage.dox

doc/mainpage.dox

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
/**
2+
3+
\mainpage
4+
5+
\htmlinclude manifest.html
6+
7+
\b mqtt_client provides a ROS nodelet that enables connected ROS-based devices or robots to exchange ROS messages via an MQTT broker using the MQTT protocol. This works generically for arbitrary ROS message types.
8+
9+
Please note that this is the Code API Documentation. Check out the <a href=https://github.com/ika-rwth-aachen/mqtt_client>GitHub repository</a> for more information on how to use the package, including a <i>Quick Start</i> guide.
10+
11+
<ul>
12+
<li><a href=files.html>Files</a></li>
13+
<li><a href=annotated.html>Classes</a></li>
14+
<li><a href=index-msg.html>Msg/Srv Documentation</a></li>
15+
</ul>
16+
17+
*/

0 commit comments

Comments
 (0)