Skip to content

Commit 2051853

Browse files
committed
Changes to vma doc generation
1 parent 2ebeb76 commit 2051853

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

generate-new/readme.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,13 @@ In an environment with `doxygen` (`nix-shell -p doxygen`), in the
3232
`VulkanMemoryAllocator/VulkanMemoryAllocator` directory.
3333

3434
```bash
35-
(cd src &&
36-
sed -i -e 's|^GENERATE_DOCBOOK.*|GENERATE_DOCBOOK=YES|' \
37-
-e 's|^BRIEF_MEMBER_DESC.*|BRIEF_MEMBER_DESC=NO|' \
38-
-e 's|^PREDEFINED *=|PREDEFINED = VMA_STATS_STRING_ENABLED=1 |' \
39-
-e 's|^PREDEFINED *=|PREDEFINED = VMA_EXTENDS_VK_STRUCT(s)=s |' \
40-
-e 's|@CMAKE_SOURCE_DIR@/||' \
41-
Doxyfile &&
42-
doxygen Doxyfile)
35+
sed -i -e 's|^GENERATE_DOCBOOK.*|GENERATE_DOCBOOK=YES|' \
36+
-e 's|^BRIEF_MEMBER_DESC.*|BRIEF_MEMBER_DESC=NO|' \
37+
-e 's|^PREDEFINED *=|PREDEFINED = VMA_STATS_STRING_ENABLED=1 |' \
38+
-e 's|^PREDEFINED *=|PREDEFINED = VMA_EXTENDS_VK_STRUCT(s)=s |' \
39+
-e 's|@CMAKE_SOURCE_DIR@/||' \
40+
Doxyfile
41+
nix-shell -p doxygen --run 'doxygen Doxyfile'
4342
```
4443

4544
The docbook documentation will be in `docs/docbook`.

scripts/regenerate.sh

+3-1
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,10 @@ echo "Generating VMA documentation" &&
4040
sed -i -e 's|^GENERATE_DOCBOOK.*|GENERATE_DOCBOOK=YES|' \
4141
-e 's|^BRIEF_MEMBER_DESC.*|BRIEF_MEMBER_DESC=NO|' \
4242
-e 's|^PREDEFINED *=|PREDEFINED = VMA_STATS_STRING_ENABLED=1 |' \
43+
-e 's|^PREDEFINED *=|PREDEFINED = VMA_EXTENDS_VK_STRUCT(s)=s |' \
44+
-e 's|@CMAKE_SOURCE_DIR@/||' \
4345
Doxyfile &&
44-
nix-shell -p cmake vulkan-headers vulkan-loader doxygen --run 'cmake . -DBUILD_DOCUMENTATION=ON && cmake --build . --target doc_doxygen' )
46+
nix-shell -p doxygen --run 'doxygen Doxyfile')
4547

4648
echo "Generating Vulkan-Docs headers"
4749
(cd generate-new/Vulkan-Docs/xml &&

0 commit comments

Comments
 (0)