6910f5dcb6
The motivation is as stated in issue #7814: even though the the C++ API is internal and unstable, people still want it to be well documented for sake of learning, code review, and other purposes that aren't predicated on it being stable. Fixes #7814 Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
20 lines
583 B
Makefile
20 lines
583 B
Makefile
.PHONY: internal-api-html
|
|
|
|
ifeq ($(internal_api_docs), yes)
|
|
|
|
$(docdir)/internal-api/html/index.html $(docdir)/internal-api/latex: $(d)/doxygen.cfg
|
|
mkdir -p $(docdir)/internal-api
|
|
{ cat $< ; echo "OUTPUT_DIRECTORY=$(docdir)/internal-api" ; } | doxygen -
|
|
|
|
# Generate the HTML API docs for Nix's unstable internal interfaces.
|
|
internal-api-html: $(docdir)/internal-api/html/index.html
|
|
|
|
else
|
|
|
|
# Make a nicer error message
|
|
internal-api-html:
|
|
@echo "Internal API docs are disabled. Configure with '--enable-internal-api-docs', or avoid calling 'make internal-api-html'."
|
|
@exit 1
|
|
|
|
endif
|