Skip to content

Commit 7fc6905

Browse files
committed
Add typedefs to documentation.js rules
1 parent b8c03bc commit 7fc6905

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

tools/make/lib/docs/documentationjs.mk

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
# Define the path of the documentation.js executable:
55
DOCUMENTATIONJS ?= $(BIN)/documentation
66

7+
# Define the path to JSDoc type definitions:
8+
DOCUMENTATIONJS_TYPEDEF ?= $(ROOT)/tools/docs/jsdoc/typedefs/*.js
9+
710
# Define the output directory for documentation.js:
811
DOCUMENTATIONJS_OUT ?= $(DOCS_DIR)/documentationjs
912

@@ -42,7 +45,7 @@ DOCUMENTATIONJS_JSON_FLAGS ?= --format json
4245
documentationjs-html: node_modules
4346
-rm -rf $(DOCUMENTATIONJS_HTML_OUT)
4447
mkdir -p $(DOCUMENTATIONJS_HTML_OUT)
45-
$(DOCUMENTATIONJS) $(DOCUMENTATIONJS_HTML_FLAGS) $(SOURCES)
48+
$(DOCUMENTATIONJS) $(DOCUMENTATIONJS_HTML_FLAGS) $(DOCUMENTATIONJS_TYPEDEF) $(SOURCES)
4649

4750

4851
# Generate JSDoc JSON.
@@ -58,7 +61,7 @@ documentationjs-html: node_modules
5861
documentationjs-json: node_modules
5962
-rm -f $(DOCUMENTATIONJS_JSON_PATH)
6063
mkdir -p $(DOCUMENTATIONJS_JSON_OUT)
61-
$(DOCUMENTATIONJS) $(DOCUMENTATIONJS_JSON_FLAGS) $(SOURCES) > $(DOCUMENTATIONJS_JSON_PATH)
64+
$(DOCUMENTATIONJS) $(DOCUMENTATIONJS_JSON_FLAGS) $(DOCUMENTATIONJS_TYPEDEF) $(SOURCES) > $(DOCUMENTATIONJS_JSON_PATH)
6265

6366

6467
# View HTML documentation.

0 commit comments

Comments
 (0)