Changes to vma doc generation

expipiplus1 · Oct 21, 2023 · 2051853 · 2051853
1 parent 2ebeb76
commit 2051853
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 9 deletions.
diff --git a/generate-new/readme.md b/generate-new/readme.md
@@ -32,14 +32,13 @@ In an environment with `doxygen` (`nix-shell -p doxygen`), in the
 `VulkanMemoryAllocator/VulkanMemoryAllocator` directory.
 
 ```bash
-(cd src &&
-  sed -i -e 's|^GENERATE_DOCBOOK.*|GENERATE_DOCBOOK=YES|' \
-         -e 's|^BRIEF_MEMBER_DESC.*|BRIEF_MEMBER_DESC=NO|' \
-         -e 's|^PREDEFINED *=|PREDEFINED = VMA_STATS_STRING_ENABLED=1 |' \
-         -e 's|^PREDEFINED *=|PREDEFINED = VMA_EXTENDS_VK_STRUCT(s)=s |' \
-         -e 's|@CMAKE_SOURCE_DIR@/||' \
-         Doxyfile &&
-  doxygen Doxyfile)
+sed -i -e 's|^GENERATE_DOCBOOK.*|GENERATE_DOCBOOK=YES|' \
+       -e 's|^BRIEF_MEMBER_DESC.*|BRIEF_MEMBER_DESC=NO|' \
+       -e 's|^PREDEFINED *=|PREDEFINED = VMA_STATS_STRING_ENABLED=1 |' \
+       -e 's|^PREDEFINED *=|PREDEFINED = VMA_EXTENDS_VK_STRUCT(s)=s |' \
+       -e 's|@CMAKE_SOURCE_DIR@/||' \
+       Doxyfile
+nix-shell -p doxygen --run 'doxygen Doxyfile'
 ```
 
 The docbook documentation will be in `docs/docbook`.

diff --git a/scripts/regenerate.sh b/scripts/regenerate.sh
@@ -40,8 +40,10 @@ echo "Generating VMA documentation" &&
   sed -i -e 's|^GENERATE_DOCBOOK.*|GENERATE_DOCBOOK=YES|' \
          -e 's|^BRIEF_MEMBER_DESC.*|BRIEF_MEMBER_DESC=NO|' \
          -e 's|^PREDEFINED *=|PREDEFINED = VMA_STATS_STRING_ENABLED=1 |' \
+         -e 's|^PREDEFINED *=|PREDEFINED = VMA_EXTENDS_VK_STRUCT(s)=s |' \
+         -e 's|@CMAKE_SOURCE_DIR@/||' \
          Doxyfile &&
-  nix-shell -p cmake vulkan-headers vulkan-loader doxygen --run 'cmake . -DBUILD_DOCUMENTATION=ON && cmake --build . --target doc_doxygen' )
+  nix-shell -p doxygen --run 'doxygen Doxyfile')
 
 echo "Generating Vulkan-Docs headers"
 (cd generate-new/Vulkan-Docs/xml &&