Skip to content

doc: Fix doc build#637

Merged
finger563 merged 5 commits into
mainfrom
doc/fix
Jun 9, 2026
Merged

doc: Fix doc build#637
finger563 merged 5 commits into
mainfrom
doc/fix

Conversation

@finger563

Copy link
Copy Markdown
Contributor
  • fix socket doc ref
  • fix doc
  • fix docs more

Copilot AI review requested due to automatic review settings June 9, 2026 15:48
@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown

✅Static analysis result - no issues found! ✅

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread doc/en/network/socket.rst
-------

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);
@finger563 finger563 merged commit 6a09664 into main Jun 9, 2026
112 of 113 checks passed
@finger563 finger563 deleted the doc/fix branch June 9, 2026 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants