zlib and brotli missing documentation

[vinniefalco]

Mr Docs only runs on the main library. The ZLib and Brotli libraries are skipped, and we need them included so we can see the symbols.

[vinniefalco]

@claude any ideas?

[claude]

Claude finished @vinniefalco's task —— View job • claude/issue-13-20251129-1713 • Create PR ➔

---

Investigating zlib and brotli documentation issue

Tasks

• Read repository guidelines (CLAUDE.md)
• Explore repository structure to locate zlib/brotli code
• Find Mr Docs configuration
• Identify why zlib/brotli are skipped
• Implement solution

Analysis

I found the issue in CMakeLists.txt:133-158. The zlib and brotli headers were being excluded from documentation generation:

Problem 1 (line 133):

list(FILTER BOOST_CAPY_HEADERS EXCLUDE REGEX ".*/(zlib|brotli).*")

This explicitly filters out all zlib and brotli headers from the main library.

Problem 2 (lines 153-158):

if (BOOST_CAPY_MRDOCS_BUILD)
    file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/mrdocs.cpp" "#include <boost/capy.hpp>\n")
    ...
    return()
endif()

When building for mrdocs, it creates a special target that only includes <boost/capy.hpp> and returns early, before the separate zlib and brotli library targets are defined. Since <boost/capy.hpp> doesn't include zlib or brotli headers, they never get documented.

Solution

Modified the mrdocs build section in CMakeLists.txt:153-162 to include the zlib and brotli headers in the generated source file:

if (BOOST_CAPY_MRDOCS_BUILD)
    file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/mrdocs.cpp"
        "#include <boost/capy.hpp>\n"
        "#include <boost/capy/zlib.hpp>\n"
        "#include <boost/capy/brotli.hpp>\n")
    add_library(boost_capy_mrdocs "${CMAKE_CURRENT_BINARY_DIR}/mrdocs.cpp")
    boost_capy_setup_properties(boost_capy_mrdocs)
    boost_capy_setup_properties(boost_capy_mrdocs PUBLIC BOOST_CAPY_MRDOCS)
    return()
endif()

This ensures that symbols from the zlib and brotli libraries (boost::capy::zlib::* and boost::capy::brotli::*) are now included when mrdocs generates the documentation.

---

Branch |