Bug 198521 – [GTK] Documentation is built even when setting says it is off

• Component: WebKitGTK
• Status: RESOLVED WONTFIX

[Xabier Rodríguez Calvar]

...
--  ENABLE_GTKDOC                            OFF
...
--  ENABLE_INTROSPECTION                     OFF
...
[6148/6200] Generating ../docs-build-no-html.stamp

[Michael Catanzaro]

That's the test target for ENABLE_DEVELOPER_MODE which checks that the docs can be built but skips HTML output generation. If you don't want it to use gtkdoc at all, then you should not use developer mode.

ADD_GTKDOC_GENERATOR("docs-build.stamp" "--gtk")
if (ENABLE_GTKDOC)
    add_custom_target(gtkdoc ALL DEPENDS "${CMAKE_BINARY_DIR}/docs-build.stamp")
elseif (NOT ENABLED_COMPILER_SANITIZERS AND NOT CMAKE_CROSSCOMPILING AND NOT APPLE)
    add_custom_target(gtkdoc DEPENDS "${CMAKE_BINARY_DIR}/docs-build.stamp")

    # Add a default build step which check that documentation does not have any warnings
    # or errors. This is useful to prevent breaking documentation inadvertently during
    # the course of development.
    if (DEVELOPER_MODE)
        ADD_GTKDOC_GENERATOR("docs-build-no-html.stamp" "--gtk;--skip-html")
        add_custom_target(gtkdoc-no-html ALL DEPENDS "${CMAKE_BINARY_DIR}/docs-build-no-html.stamp")
    endif ()
endif ()

[Xabier Rodríguez Calvar]

What's the rationale behind this? Even in developer mode, it is very confusing to deactivate something and getting it anyway.

[Carlos Garcia Campos]

Docs are not generated (there's no generated html documentation), but gtk-doc is used to check there aren't errors in documentation like undocumented symbols. It could be renamed to ENABLE_API_DOCUMENTATION for example, if that's clearer.

[Michael Catanzaro]

(In reply to Xabier Rodríguez Calvar from comment #2)
> What's the rationale behind this?

Before we added this, developers who built with gtkdoc disabled kept breaking the docs build. :)