docs: update doxygen

.github/workflows/docs.yml

@@ -4,25 +4,42 @@ on:
   push:
     branches: [main]
     tags: ['v*']
-    # Only rebuild when something the docs actually depend on changes —
+    # Only rebuild when something actually changes —
     # source under the three subprojects, the Doxyfile, or this workflow.
     paths:
-      - 'CMOD/**'
-      - 'LASS/**'
-      - 'LASSIE/**'
+      - 'CMOD/**/*.cpp'
+      - 'CMOD/**/*.hpp'
+      - 'CMOD/**/*.h'
+      - 'LASS/**/*.cpp'
+      - 'LASS/**/*.hpp'
+      - 'LASS/**/*.h'
+      - 'LASSIE/**/*.cpp'
+      - 'LASSIE/**/*.hpp'
+      - 'LASSIE/**/*.h'
+      - 'Doxyfile'
+      - '.github/workflows/docs.yml'
+  pull_request:
+    paths:
+      - 'CMOD/**/*.cpp'
+      - 'CMOD/**/*.hpp'
+      - 'CMOD/**/*.h'
+      - 'LASS/**/*.cpp'
+      - 'LASS/**/*.hpp'
+      - 'LASS/**/*.h'
+      - 'LASSIE/**/*.cpp'
+      - 'LASSIE/**/*.hpp'
+      - 'LASSIE/**/*.h'
       - 'Doxyfile'
       - '.github/workflows/docs.yml'
   workflow_dispatch:
 
 permissions:
   contents: write   # peaceiris/actions-gh-pages pushes to the gh-pages branch.
 
-# Serialize runs so two pushes can't race and overwrite each other's
-# top-level index. Don't cancel in-progress runs — that would leave a
-# half-published version subdir.
+# PRs get their own cancellable group; push runs serialize to avoid races.
 concurrency:
-  group: docs-pages
-  cancel-in-progress: false
+  group: ${{ github.event_name == 'pull_request' && format('docs-pr-{0}', github.head_ref) || 'docs-pages' }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
 
 jobs:
   build:
@@ -108,6 +125,7 @@ jobs:
           HTML
 
       - name: Assemble publish tree
+        if: github.event_name != 'pull_request'
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           TARGET:   ${{ steps.target.outputs.dir }}
@@ -213,6 +231,7 @@ jobs:
           } > publish/index.html
 
       - name: Publish to gh-pages
+        if: github.event_name != 'pull_request'
         uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

CMOD/src/Bottom.h

@@ -421,7 +421,7 @@ class Bottom : public Event {
      *  Sets the reverberation of a sound according to a simple
      *     "room size" parameter
      *  \param s a pointer to the sound being created
-     *  \param paramsElement pointer to the <Sizes> element
+     *  \param paramsElement pointer to the `<Sizes>` element
      *  \param applyHow string containing info if it applies to sound or
      *     individual partials
      *  \param numPartials the number of partials contained in the sound
@@ -436,7 +436,7 @@ class Bottom : public Event {
      *     "hi/low spread", "gain all pass", and "delay" parameters
      *     ==== Applying by partial not implemented in LASSIE ====
      * \param s a pointer to the sound being created
-     * \param paramsElement pointer to the <Percent> (envelope) element
+     * \param paramsElement pointer to the `<Percent>` (envelope) element
      * \param applyHow string containing info if it applies to sound or
      *     individual partials
      * \param numPartials the number of partials contained in the sound
@@ -452,7 +452,7 @@ class Bottom : public Event {
      *     "gain all pass", and "delay" parameters
      *     ==== Applying by partial not implemented in LASSIE ====
      * \param s a pointer to the sound being created
-     * \param paramsElement pointer to the <Percent> (envelope) element
+     * \param paramsElement pointer to the `<Percent>` (envelope) element
      * \param applyHow string containing info if it applies to sound or
      *     individual partials
      * \param numPartials the number of partials contained in the sound

CMOD/src/Utilities.h

@@ -334,7 +334,7 @@ std::map<int, string> notesEventnames;
   /**
    * Helper function for finding, in a string, the substring which represents
    * a CMOD function.
-   * This function assume that at least 1 "<Fun>" exists in the string.
+   * This function assume that at least 1 `<Fun>` exists in the string.
    * \param _input The string to search
    * \return The index of _input where the substring begins
    **/