Conversation
finger563
commented
Jun 9, 2026
Contributor
- fix socket doc ref
- fix doc
- fix docs more
|
✅Static analysis result - no issues found! ✅ |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR focuses on fixing documentation build issues by correcting references and converting content into Sphinx/Doxygen-friendly formats, while also aligning several examples with snippet extraction markers used by the generated docs.
Changes:
- Fix/adjust documentation structure and formatting (Sphinx toctree entry, ADRC table formatting).
- Update Doxygen snippet references for RTSP packetizers/depicketizers and add snippet markers to examples.
- Minor docstring clarifications across a few components.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/en/network/socket.rst | Adjusts the socket docs example reference (currently removes Sphinx cross-ref). |
| doc/en/index.rst | Adds xiao_esp32s3_sense to the main documentation toctree. |
| doc/en/adrc.rst | Converts an ASCII table into a Sphinx list-table for better rendering/build reliability. |
| components/xiao-esp32s3-sense/example/main/xiao_esp32s3_sense_example.cpp | Adds snippet markers for documentation extraction. |
| components/spi/include/spi.hpp | Improves/clarifies Doxygen comments for config conversion helpers. |
| components/rtsp/include/h264_packetizer.hpp | Points the example snippet to the RTSP example test snippet. |
| components/rtsp/include/h264_depacketizer.hpp | Points the example snippet to the RTSP example test snippet. |
| components/rtsp/include/generic_packetizer.hpp | Points the example snippet to the RTSP example test snippet. |
| components/rtsp/include/generic_depacketizer.hpp | Points the example snippet to the RTSP example test snippet. |
| components/motorgo-plink/example/main/motorgo_plink_example.cpp | Adds snippet markers and changes the loop delay implementation. |
| components/m5stack-tab5/include/m5stack-tab5.hpp | Clarifies parameter docs for reset helpers. |
| components/i2c/include/i2c_master_menu.hpp | Adds missing @param documentation for bus parameters. |
| components/i2c/include/i2c_master_device_menu.hpp | Adds missing @param documentation for device parameters. |
| components/dns_server/example/main/dns_server_example.cpp | Adds snippet markers for documentation extraction. |
| ------- | ||
|
|
||
| The :doc:`socket_example <network/socket_example>` page shows the use of the | ||
| The ``network/socket_example`` page shows the use of the |
Comment on lines
+195
to
+196
| using namespace std::chrono_literals; | ||
| std::this_thread::sleep_for(500ms); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.