Enhancement with doxygen

2023-01-02 03:52:29 +01:00 · 2023-01-02 03:52:29 +01:00 · f8f2e8ea9e
commit f8f2e8ea9e
parent e77b980009
4 changed files with 62 additions and 41 deletions
--- a/.github/workflows/doxygen-action.yml.disabled
+++ b/.github/workflows/doxygen-action.yml.disabled
@ -1,17 +0,0 @@
-# See syntax file on https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions
-name: Doxygen
-on:
-  schedule:
-  - cron: "0 15 * * *"
-  workflow_dispatch:
-    branches:
-      - develop
-
-jobs:
-  doxygen:
-    runs-on: ubuntu-latest
-    steps:
-      - name: 'Doxygen'
-        uses: mattnotmitt/doxygen-action@1.9.5
-        with:
-          doxyfile-path: build/doxygen
--- a/.github/workflows/doxygen-gh-pages.yml
+++ b/.github/workflows/doxygen-gh-pages.yml
@ -0,0 +1,38 @@
+# See syntax file on https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions
+name: Doxygen
+on:
+  schedule:
+  - cron: "0 15 * * *"
+  workflow_dispatch:
+    branches:
+      - develop
+permissions:
+  contents: write
+  
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Build
+        uses: DenverCoder1/doxygen-github-pages-action@v1.2.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: gh-pages
+          folder: docs/html
+          config_file: build/doxygen/dolibarr-doxygen.doxyfile
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: docs/html # The folder the action should deploy.
+          target-folder: docs/html2
+          
+#jobs:
+#  doxygen:
+#    runs-on: ubuntu-latest
+#    steps:
+#      - name: 'Doxygen'
+#        uses: mattnotmitt/doxygen-action@1.9.5
+#        with:
+#          doxyfile-path: build/doxygen
--- a/build/doxygen/dolibarr-doxygen-build.pl
+++ b/build/doxygen/dolibarr-doxygen-build.pl
@ -17,9 +17,9 @@ use Cwd;
 my $dir = getcwd;

 print "Current dir is: $dir\n";
-print "Running dir for doxygen must be: $DIR\n";
+#print "Running dir for doxygen must be: $DIR\n";

-if (! -s $CONFFILE)
+if (! -s "build/doxygen/$CONFFILE")
 {
    print "Error: current directory for building Dolibarr doxygen documentation is not correct.\n";
    print "\n";
@ -30,7 +30,7 @@ if (! -s $CONFFILE)
    exit 1;   
 }

-$SOURCE="../..";
+$SOURCE=".";

 # Get version $MAJOR, $MINOR and $BUILD
 $result = open( IN, "< " . $SOURCE . "/htdocs/filefunc.inc.php" );
@ -47,8 +47,8 @@ $version=$MAJOR.".".$MINOR.".".$BUILD;


 print "Running doxygen for version ".$version.", please wait...\n";
-print "cat $CONFFILE | sed -e 's/x\.y\.z/".$version."/' | doxygen $OPTIONS - 2>&1\n";
-$result=`cat $CONFFILE | sed -e 's/x\.y\.z/$version/' | doxygen $OPTIONS - 2>&1`;
+print "cat build/doxygen/$CONFFILE | sed -e 's/x\.y\.z/".$version."/' | doxygen $OPTIONS - 2>&1\n";
+$result=`cat build/doxygen/$CONFFILE | sed -e 's/x\.y\.z/$version/' | doxygen $OPTIONS - 2>&1`;

 print $result;

--- a/build/doxygen/dolibarr-doxygen.doxyfile
+++ b/build/doxygen/dolibarr-doxygen.doxyfile
@ -41,7 +41,7 @@ PROJECT_NUMBER = x.y.z
 # If a relative path is entered, it will be relative to the location
 # where doxygen was started. If left blank the current directory will be used.

-OUTPUT_DIRECTORY = ../../build
+OUTPUT_DIRECTORY = build

 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
 # 4096 sub-directories (in 2 levels) under the output directory of each output
@ -117,7 +117,7 @@ FULL_PATH_NAMES = YES
 # If left blank the directory from which doxygen is run is used as the
 # path to strip.

-STRIP_FROM_PATH = "../.."
+STRIP_FROM_PATH = ""

 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
 # the path mentioned in the documentation of a class, which tells
@ -290,7 +290,7 @@ TYPEDEF_HIDES_STRUCT = NO
 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
 # corresponding to a cache size of 2^16 = 65536 symbols

-SYMBOL_CACHE_SIZE = 0
+#SYMBOL_CACHE_SIZE = 0

 #---------------------------------------------------------------------------
 # Build related configuration options
@ -490,7 +490,7 @@ SHOW_USED_FILES = YES
 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
 # in the documentation. The default is NO.

-SHOW_DIRECTORIES = YES
+#SHOW_DIRECTORIES = YES

 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
 # This will remove the Files entry from the Quick Index and from the
@ -574,7 +574,7 @@ WARN_FORMAT = "$file:$line: $text"
 # and error messages should be written. If left blank the output is written
 # to stderr.

-WARN_LOGFILE = doxygen_warnings.log
+WARN_LOGFILE = build/html/doxygen_warnings.log

 #---------------------------------------------------------------------------
 # configuration options related to the input files
@ -585,7 +585,7 @@ WARN_LOGFILE = doxygen_warnings.log
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.

-INPUT = ../../htdocs ../../scripts
+INPUT = htdocs scripts

 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@ -614,7 +614,7 @@ RECURSIVE = YES
 # excluded from the INPUT source files. This way you can easily exclude a
 # subdirectory from a directory tree whose root is specified with the INPUT tag.

-EXCLUDE = ../../build ../../dev ../../doc ../../document ../../documents ../../htdocs/conf/conf.php ../../htdocs/custom ../../htdocs/document ../../htdocs/documents ../../htdocs/includes
+EXCLUDE = build dev doc document documents htdocs/conf/conf.php htdocs/custom htdocs/document htdocs/documents htdocs/includes

 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
 # directories that are symbolic links (a Unix filesystem feature) are excluded
@ -642,7 +642,7 @@ EXCLUDE_SYMBOLS =
 # directories that contain example code fragments that are included (see
 # the \include command).

-EXAMPLE_PATH = ../../htdocs/modulebuilder/template 
+EXAMPLE_PATH = htdocs/modulebuilder/template 

 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@ -662,7 +662,7 @@ EXAMPLE_RECURSIVE = NO
 # directories that contain image that are included in the documentation (see
 # the \image command).

-IMAGE_PATH = ../../doc/images
+IMAGE_PATH = doc/images

 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
@ -765,7 +765,7 @@ ALPHABETICAL_INDEX = YES
 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
 # in which this list will be split (can be a number in the range [1..20])

-COLS_IN_ALPHA_INDEX = 5
+#COLS_IN_ALPHA_INDEX = 5

 # In case all classes in a project start with a common prefix, all
 # classes will be put under the same header in the alphabetical index.
@ -802,14 +802,14 @@ HTML_FILE_EXTENSION = .html
 # standard header.

 # Does not work with 1.7.3
-#HTML_HEADER = doxygen_header.html
+#HTML_HEADER = build/doxygen/doxygen_header.html

 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
 # each generated HTML page. If it is left blank doxygen will generate a
 # standard footer.

 # Does not work with 1.7.3
-HTML_FOOTER = doxygen_footer.html
+HTML_FOOTER = build/doxygen/doxygen_footer.html

 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
 # style sheet that is used by each HTML page. It can be used to
@ -855,7 +855,7 @@ HTML_TIMESTAMP = YES
 # files or namespaces will be aligned in HTML using tables. If set to
 # NO a bullet list will be used.

-HTML_ALIGN_MEMBERS = YES
+#HTML_ALIGN_MEMBERS = YES

 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
 # documentation will contain a main index with vertical navigation menus that
@ -1051,7 +1051,7 @@ GENERATE_TREEVIEW = NO
 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
 # and Class Hierarchy pages using a tree view instead of an ordered list.

-USE_INLINE_TREES = NO
+#USE_INLINE_TREES = NO

 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
 # used to set the initial width (in pixels) of the frame in which the tree
@ -1098,7 +1098,7 @@ SEARCHENGINE = YES
 # full text search. The disadvances is that it is more difficult to setup
 # and does not have live searching capabilities.

-SERVER_BASED_SEARCH = NO
+SERVER_BASED_SEARCH = YES

 #---------------------------------------------------------------------------
 # configuration options related to the LaTeX output
@ -1276,13 +1276,13 @@ XML_OUTPUT = xml
 # which can be used by a validating XML parser to check the
 # syntax of the XML files.

-XML_SCHEMA = 
+#XML_SCHEMA = 

 # The XML_DTD tag can be used to specify an XML DTD,
 # which can be used by a validating XML parser to check the
 # syntax of the XML files.

-XML_DTD = 
+#XML_DTD = 

 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
 # dump the program listings (including syntax highlighting
@ -1447,7 +1447,7 @@ EXTERNAL_GROUPS = YES
 # The PERL_PATH should be the absolute path and name of the perl script
 # interpreter (i.e. the result of `which perl').

-PERL_PATH = /usr/bin/perl
+#PERL_PATH = /usr/bin/perl

 #---------------------------------------------------------------------------
 # Configuration options related to the dot tool
@ -1469,7 +1469,7 @@ CLASS_DIAGRAMS = NO
 # the mscgen tool resides. If left empty the tool is assumed to be found in the
 # default search path.

-MSCGEN_PATH = 
+#MSCGEN_PATH = 

 # If set to YES, the inheritance and collaboration graphs will hide
 # inheritance and usage relations if the target is undocumented