Skip to content

Commit dfb7413

Browse files
committed
Add rule for rebuilding JSDoc HTML documentation
1 parent cc060a3 commit dfb7413

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

tools/make/lib/docs/jsdoc.mk

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,5 +92,19 @@ clean-jsdoc:
9292
-rm -rf $(JSDOC_OUT)
9393

9494

95-
.PHONY: docs-src docs-jsdoc jsdoc-json view-src-docs clean-jsdoc
95+
# Rebuild JSDoc HTML documentation.
96+
#
97+
# This target removes any current documentation and regenerates source HTML documentation from [JSDoc][1]-style comments.
98+
#
99+
# To install JSDoc:
100+
# $ npm install jsdoc
101+
#
102+
# [1]: http://usejsdoc.org/
103+
104+
rebuild-src-docs:
105+
@$(MAKE) -f $(THIS_FILE) clean-jsdoc
106+
@$(MAKE) -f $(THIS_FILE) docs-jsdoc
107+
108+
109+
.PHONY: docs-src docs-jsdoc jsdoc-json view-src-docs rebuild-src-docs clean-jsdoc
96110

0 commit comments

Comments
 (0)