bump Doxygen to 1.9.6 for code layout tests (#51450)

qgis · Jan 12, 2023 · 216fdff · 216fdff
1 parent 07f3a6e
commit 216fdff
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 24 deletions.
diff --git a/.github/workflows/code_layout.yml b/.github/workflows/code_layout.yml
@@ -8,43 +8,31 @@ on:
       - queued_ltr_backports
   pull_request:
 
+env:
+  DOXYGEN_VERSION: 1.9.6
+
 jobs:
   documentation_checks:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: Set up Python 3.7
+      - name: Set up Python 3.10
         uses: actions/setup-python@v4
         with:
-          python-version: 3.7
-      - name: Install Requirements
+          python-version: '3.10' 
+      - name: Install requirements
         run: |
-          sudo apt install -y \
-              doxygen \
-              cpanminus \
-              libyaml-tiny-perl \
-              libio-socket-ssl-perl \
-              libhttp-date-perl \
-              libgetopt-long-descriptive-perl \
-              libmoo-perl \
-              libnamespace-clean-perl \
-              libpath-tiny-perl \
-              libpod-constants-perl \
-              libscalar-list-utils-perl \
-              libsort-key-perl \
-              libstrictures-perl \
-              libstring-escape-perl \
-              libtry-tiny-perl \
-              expect
-            cpanm --notest App::Licensecheck
+          wget https://www.doxygen.nl/files/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz
+          tar -xzf doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz
           python -m pip install --upgrade pip
           pip install autopep8 nose2 mock termcolor
       - name: Make
         run: |
-         mkdir build
-         cd build
-         cmake -DWITH_SERVER=ON -DUSE_CCACHE=OFF -DWITH_CORE=OFF -DWITH_APIDOC=ON -DWITH_ASTYLE=ON -DENABLE_TESTS=ON -DWITH_DOT=NO -DWERROR=ON ..
+          mkdir build
+          cd build
+          cmake -DUSE_CCACHE=OFF -DWITH_CORE=OFF -DWITH_APIDOC=ON -DWITH_ASTYLE=ON -DENABLE_TESTS=ON \
+                -DWITH_DOT=NO -DWERROR=ON -DDOXYGEN_EXECUTABLE=../doxygen-${DOXYGEN_VERSION}/bin/doxygen ..
           make -j3 apidoc
       - name: Run Tests
         run: cd build && ctest -V -R PyQgsDocCoverage

diff --git a/src/analysis/vector/geometry_checker/qgsgeometryduplicatecheck.h b/src/analysis/vector/geometry_checker/qgsgeometryduplicatecheck.h
@@ -29,6 +29,7 @@
 class ANALYSIS_EXPORT QgsGeometryDuplicateCheckError : public QgsGeometryCheckError
 {
   public:
+    //! Constructor
     QgsGeometryDuplicateCheckError( const QgsGeometryCheck *check,
                                     const QgsGeometryCheckerUtils::LayerFeature &layerFeature,
                                     const QgsPointXY &errorLocation,
@@ -37,8 +38,11 @@ class ANALYSIS_EXPORT QgsGeometryDuplicateCheckError : public QgsGeometryCheckEr
       : QgsGeometryCheckError( check, layerFeature, errorLocation, QgsVertexId(), duplicatesString( featurePools, duplicates ) )
       , mDuplicates( duplicates )
     { }
+
+    //! Returns the duplicates
     QMap<QString, QList<QgsFeatureId>> duplicates() const { return mDuplicates; }
 
+    //! Returns if the \a other error is equivalent
     bool isEqual( QgsGeometryCheckError *other ) const override
     {
       return other->check() == check() &&