Renamed the "copy-docs" and "gen-doc" functions defined in the Makefile file as "copy-archives" and "generate-archive" respectively.

This commit is contained in:
Javier Cicchelli 2025-03-19 00:19:14 +01:00
parent 2b1c97d728
commit d27ee769aa

View File

@ -10,11 +10,11 @@ TARGET_LIBRARY = DoxyLibrary
# FUNCTIONS
define copy-docs
define copy-archives
@cp -rf $(DOCC_BUILD_FOLDER)/$(DOCC_ARCHIVES) $(1)
endef
define gen-doc
define generate-archive
@swift package plugin generate-documentation\
--target $(1)\
--hosting-base-path "archives/$(1)"\
@ -58,9 +58,9 @@ update: ## Updates the SPM package dependencies.
# DOCUMENTATION
build-doc: ## Builds the DocC documentation for the apps and library targets.
@$(call gen-doc,$(TARGET_APP))
@$(call gen-doc,$(TARGET_LIBRARY))
@$(call copy-docs,$(DOCC_ARCHIVES_FOLDER))
@$(call generate-archive,$(TARGET_APP))
@$(call generate-archive,$(TARGET_LIBRARY))
@$(call copy-archives,$(DOCC_ARCHIVES_FOLDER))
preview-doc: ## Previews the DocC documentation for the library target.
@swift package --disable-sandbox plugin preview-documentation\
@ -70,9 +70,9 @@ preview-doc: ## Previews the DocC documentation for the library target.
--enable-inherited-docs
test-doc: ## Builds the DocC documentation for the app and the library targets in the test folder.
@$(call gen-doc,$(TARGET_APP))
@$(call gen-doc,$(TARGET_LIBRARY))
@$(call copy-docs,$(DOCC_TEST_FOLDER))
@$(call generate-archive,$(TARGET_APP))
@$(call generate-archive,$(TARGET_LIBRARY))
@$(call copy-archives,$(DOCC_TEST_FOLDER))
# DOCKER