From 8e7bb480afec21f2dc01b3249432614fcbeed89d Mon Sep 17 00:00:00 2001 From: Override-6 Date: Tue, 17 Jan 2023 20:06:23 +0100 Subject: [PATCH] doxygen generator now considerates input path as the used Doxyfile path instead of a path of a folder that contains a Doxyfile file --- README.md | 5 +++-- generators/doxygen.sh | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 541114c..41dd0ff 100644 --- a/README.md +++ b/README.md @@ -20,13 +20,14 @@ This command generates the documentation and deploys it on your CodeDoc space - `-d --dest [dir]` path to where to put the documentation outputs in your repository's CodeDoc space - **optional !! cannot be absolute !!** Note ! -For swagger, you have to pass the configuration file instead of a directory +For swagger and doxygen, you have to pass the configuration file instead of a directory usage examples : ``` /entrypoint.sh -l ./documentation/api/api-swagger.yml -t swagger -d api_documentation /entrypoint.sh -l ./documentation/app -t docusaurus -d application_documentation -/entrypoint.sh -l ./src -t doxygen -d sourcecode_documentation +/entrypoint.sh -l ./src/Doxyfile -t doxygen -d sourcecode_documentation ``` +### How to add custom documentation generator ? diff --git a/generators/doxygen.sh b/generators/doxygen.sh index 7ffc3c9..80d972d 100644 --- a/generators/doxygen.sh +++ b/generators/doxygen.sh @@ -8,7 +8,7 @@ generate() { fi doxygen -u - doxygen "$1/Doxyfile" + doxygen "$1" mkdir -p $GEN_PATH mv html/* $GEN_PATH