Przeglądaj źródła

Building with the Builder build system to generate HTML documentation.

David Piuva 1 dzień temu
rodzic
commit
778f83cee7

+ 13 - 0
Doc/Generator/Generator.DsrProj

@@ -0,0 +1,13 @@
+# No need to import DFPSR.DsrHead with stub backends when only including essential headers.
+CompilerFlag "-std=c++14"
+
+# If compiling using CLANG instead of GCC in tools/builder/buildProject.sh, you need to include the C++ standard library explicitly.
+#Link "stdc++"
+
+Crawl "main.cpp"
+
+# Prevent executing the application without any arguments.
+Supressed
+
+# Uncomment to enable debug mode, which is slower
+#Debug

+ 0 - 10
Doc/Generator/build.sh

@@ -1,10 +0,0 @@
-#!/bin/bash
-
-LIBRARY_PATH=../../Source/DFPSR
-DEPENDENCIES="${LIBRARY_PATH}/collection/collections.cpp ${LIBRARY_PATH}/api/fileAPI.cpp ${LIBRARY_PATH}/api/bufferAPI.cpp ${LIBRARY_PATH}/api/timeAPI.cpp ${LIBRARY_PATH}/api/stringAPI.cpp ${LIBRARY_PATH}/base/SafePointer.cpp ${LIBRARY_PATH}/base/virtualStack.cpp ${LIBRARY_PATH}/base/heap.cpp"
-
-g++ main.cpp -o generator ${DEPENDENCIES} -std=c++14 -lm
-
-# Execute the generation script to see the changes
-chmod +x gen.sh
-./gen.sh

+ 2 - 0
Doc/Generator/build_linux.sh

@@ -0,0 +1,2 @@
+chmod +x ../../Source/tools/builder/buildProject.sh;
+../../Source/tools/builder/buildProject.sh Generator.DsrProj Linux $@;

+ 2 - 0
Doc/Generator/build_macos.sh

@@ -0,0 +1,2 @@
+chmod +x ../../Source/tools/builder/buildProject.sh;
+../../Source/tools/builder/buildProject.sh Generator.DsrProj MacOS $@;

+ 1 - 0
Doc/Generator/build_windows.bat

@@ -0,0 +1 @@
+..\..\Source\tools\builder\buildProject.bat Generator.DsrProj Windows %@%

+ 4 - 0
Doc/Generator/generate.bat

@@ -0,0 +1,4 @@
+# Make sure to compile the documentation generator using build_windows.bat before calling the program with, input, output and resource paths.
+
+# Generate documentation from the folder Input to the Doc folder outside at .., using the style in Resources.
+generator Input .. Resources

+ 2 - 0
Doc/Generator/gen.sh → Doc/Generator/generate.sh

@@ -1,4 +1,6 @@
 #!/bin/bash
 
+# Make sure to compile the documentation generator using build_linux.sh or build_macos.sh before calling the program with, input, output and resource paths.
+
 # Generate documentation from the folder ./Input to the Doc folder outside at .., using the style in ./Resources.
 ./generator ./Input .. ./Resources

+ 1 - 1
Doc/Generator/main.cpp

@@ -12,7 +12,7 @@
 //   DFPSR/api/bufferAPI.cpp
 //   DFPSR/api/stringAPI.cpp
 //   DFPSR/base/SafePointer.cpp
-#include "../../Source/DFPSR/api/fileAPI.h"
+#include "../../Source/DFPSR/includeEssentials.h"
 
 using namespace dsr;