From 3db31324336d1f691dd83933aa7236c8b274c3a1 Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Thu, 13 Mar 2025 02:10:23 +0100 Subject: [PATCH] Implemented the "build-doc" and "preview-doc" targets in the Makefile file. --- Makefile | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/Makefile b/Makefile index 6ef01e2..b12cd06 100644 --- a/Makefile +++ b/Makefile @@ -23,6 +23,21 @@ reset: ## Resets the complete SPM cache/build folder from the package. update: ## Updates the SPM package dependencies. @swift package update +# DOCUMENTATION + +build-doc: ## Builds the DocC documentation for the library target. + @swift package plugin generate-documentation\ + --target DoxyLibrary\ + --include-extended-types\ + --symbol-graph-minimum-access-level internal + @cp -rf .build/plugins/Swift-DocC/outputs/DoxyLibrary.doccarchive . + +preview-doc: ## Previews the DocC documentation for the library target. + @swift package --disable-sandbox plugin preview-documentation\ + --target DoxyLibrary\ + --include-extended-types\ + --symbol-graph-minimum-access-level internal + # DOCKER build-image: ## Builds a docker image out of the current source code