Skip to content

Commit be61ddb

Browse files
emanspeaksemanspeaks
committed
init draft of javadoc parsing and doc generation
1 parent b4bfb56 commit be61ddb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+4497
-51
lines changed

‎.clangd‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
If:
2+
PathMatch: .*\.in
3+
4+
CompileFlags:
5+
Remove:
6+
- -Wall
7+
- -Wextra
8+
- -Wpedantic
9+
10+
Diagnostics:
11+
Suppress:
12+
- "*"
13+
14+
---
15+
16+
CompileFlags:
17+
Add:
18+
- -Wall
19+
- -Wextra
20+
- -Wpedantic

‎.cspell.jsonc‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,7 @@
3131
"ignoreRegExpList": [
3232
"/-W.*/",
3333
"/-D.*/",
34-
]
34+
"/-X.*/",
35+
],
36+
"allowCompoundWords": true,
3537
}

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,5 @@
1010
# /buildtools/build/
1111
/thirdparty/qt/qt/
1212
/.dep-cache/
13+
/tmp/
14+
/doc/

‎.markdownlint.jsonc‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1-
{
2-
"default": true,
3-
"MD013": false,
4-
"MD029": false,
5-
"MD053": false,
6-
"MD041": false,
7-
"MD034": false,
8-
"MD033": {
9-
"allowed_elements": [
10-
"br"
11-
]
12-
}
13-
}
1+
{
2+
"default": true,
3+
"MD013": false,
4+
"MD029": false,
5+
"MD053": false,
6+
"MD041": false,
7+
"MD034": false,
8+
"MD036": false,
9+
"MD033": {
10+
"allowed_elements": [
11+
"br"
12+
]
13+
}
14+
}

‎.vscode/ltex.dictionary.en-US.txt‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Deallocation
1313
dlopen
1414
dlsym
1515
dylib
16+
dynlib
1617
EBNF
1718
Enums
1819
Fallthrough
@@ -27,12 +28,15 @@ katex
2728
lexer
2829
libtree
2930
lightgray
31+
mac
32+
macdeployqt
3033
Monomorphization
3134
MSVC
3235
Namespacing
3336
nlohmann
3437
PYRANDYOS
3538
PYTHONUNBUFFERED
39+
qt
3640
RRGGBB
3741
Schibsted
3842
scrutinising
@@ -46,7 +50,12 @@ vaddps
4650
Variadic
4751
variadics
4852
vmovups
53+
win
4954
windarkmode
55+
windeployqt
5056
WINSYS
5157
yyjson
5258
Zig
59+
60+
CesiumDocCLI
61+
JsonDoc

‎CMakeLists.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ add_subdirectory(cesium)
3535
include(CTest)
3636
enable_testing()
3737

38+
# Add tests
39+
add_subdirectory(tests)
40+
3841
set(CPACK_PROJECT_NAME ${PROJECT_NAME})
3942
set(CPACK_PROJECT_VERSION ${PROJECT_VERSION})
4043
include(CPack)

‎CMakePresets.json‎

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,27 @@
99
"binaryDir": "${sourceDir}/build",
1010
"environment": {
1111
"buildtoolsDir": "${sourceDir}/buildtools",
12-
"buildtoolsBin": "${env:buildtoolsDir}/bin",
12+
"buildtoolsBin": "$env{buildtoolsDir}/bin",
13+
"buildtoolsOpt": "$env{buildtoolsDir}/opt",
1314
"llvmVersion": "21.1.0",
14-
"llvmBin": "${env:buildtoolsDir}/llvm-${env:llvmVersion}/bin",
15+
"llvmBin": "$env{buildtoolsOpt}/llvm-$env{llvmVersion}/bin",
1516
"QtVersion": "6.9.2",
1617
"QtTarget": "msvc2022_64",
17-
"Qt6_ROOT": "C:/Qt/${env:QtVersion}/${env:QtTarget}/lib/cmake/Qt6",
18+
"Qt6_ROOT": "C:/Qt/$env{QtVersion}/$env{QtTarget}/lib/cmake/Qt6",
19+
"vulkanVersion": "1.4.321.1",
20+
"VULKAN_SDK": "$env{buildtoolsOpt}/vulkansdk-$env{vulkanVersion}",
21+
"VK_SDK_PATH": "$env{VULKAN_SDK}",
1822
"WinSdkVersion": "10.0.26100.0",
19-
"WinSdkDir": "C:/Program Files (x86)/Windows Kits/10/bin/${env:WinSdkVersion}/x64",
20-
"WINSYS32": "${env:SystemRoot}\\System32",
21-
"PATH": "${env:buildtoolsBin};${env:WINSYS32};${env:SystemRoot};${env:WINSYS32}\\Wbem;${env:WINSYS32}\\WindowsPowerShell\\v1.0;${env:WINSYS32}\\OpenSSH;${env:ProgramFiles}\\dotnet;${env:LOCALAPPDATA}\\Microsoft\\WindowsApps;${env:LOCALAPPDATA}\\Programs\\Git\\bin;${env:ProgramFiles}\\Git\\cmd"
23+
"WinSdkDir": "C:/Program Files (x86)/Windows Kits/10/bin/$env{WinSdkVersion}/x64",
24+
"WINSYS32": "$env{SYSTEMROOT}\\System32",
25+
"PATH": "$env{VULKAN_SDK}\\bin;$env{buildtoolsBin};$env{WINSYS32};$env{SYSTEMROOT};$env{WINSYS32}\\Wbem;$env{WINSYS32}\\WindowsPowerShell\\v1.0;$env{WINSYS32}\\OpenSSH;$env{PROGRAMFILES}\\dotnet;$env{LOCALAPPDATA}\\Microsoft\\WindowsApps;$env{LOCALAPPDATA}\\Programs\\Git\\bin;$env{PROGRAMFILES}\\Git\\cmd"
2226
},
2327
"cacheVariables": {
2428
"CMAKE_BUILD_TYPE": "Debug",
2529
"CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
26-
"CMAKE_C_COMPILER": "${env:llvmBin}/clang.exe",
27-
"CMAKE_CXX_COMPILER": "${env:llvmBin}/clang++.exe",
28-
"CMAKE_RC_COMPILER": "${env:WinSdkDir}/rc.exe"
30+
"CMAKE_C_COMPILER": "$env{llvmBin}/clang.exe",
31+
"CMAKE_CXX_COMPILER": "$env{llvmBin}/clang++.exe",
32+
"CMAKE_RC_COMPILER": "$env{WinSdkDir}/rc.exe"
2933
}
3034
},
3135
{
@@ -40,7 +44,7 @@
4044
"CMAKE_CXX_COMPILER_TARGET": "x86_64-w64-mingw32",
4145
"_comment_CMAKE_CXX_COMPILER_TARGET": {
4246
"value": "This forces clang++ to link with MinGW libraries and not MSVC",
43-
"type": "UNINITIALIZED"
47+
"type": "STRING"
4448
}
4549
}
4650
}

‎buildtools‎

‎cesium-doc-config.json‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"languages": {
3+
"cpp": {
4+
"library": "tree-sitter-cpp.so",
5+
"function": "tree_sitter_cpp",
6+
"extensions": [".cpp", ".hpp", ".cc", ".h", ".cxx"],
7+
"javadoc_style": "/** */"
8+
}
9+
},
10+
"source_directories": ["cesium/src/", "cesium/include/"],
11+
"output_directory": "doc/api/",
12+
"exclude_patterns": ["**/test/**", "**/*_test.*"]
13+
}

‎cesium.code-workspace‎

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,16 @@
1010
"*.czm": "cesium"
1111
},
1212
"files.watcherExclude": {
13-
"buildtools/clang+llvm-*/": true,
14-
"buildtools/llvm-*/": true,
15-
"buildtools/bin/zig-*/": true,
16-
"buildtools/bin/zig-x86_64-windows-*/": true,
17-
"buildtools/bin/cmake-*-windows-x86_64/**": true,
18-
"buildtools/bin/cmake-*/**": true,
13+
// "buildtools/clang+llvm-*/": true,
14+
// "buildtools/llvm-*/": true,
15+
// "buildtools/bin/zig-*/": true,
16+
// "buildtools/bin/zig-x86_64-windows-*/": true,
17+
// "buildtools/bin/cmake-*-windows-x86_64/**": true,
18+
// "buildtools/bin/cmake-*/**": true,
19+
"buildtools/opt/**": true,
1920
"build/**": true,
21+
"doc/**": true,
22+
"tmp/**": true,
2023
"**/.zig-cache/**": true,
2124
"**/node_modules/**": true,
2225
"**/.cache/**": true,
@@ -47,22 +50,26 @@
4750
// "foam.files.newNotePath": "currentDir",
4851
// "foam.completion.useAlias": "whenPathDiffersFromTitle",
4952
// "foam.preview.embedNoteType": "content-inline",
50-
// "cmake.environment": {
51-
// "PATH": "${workspaceFolder}/buildtools/bin;${workspaceFolder}/buildtools/llvm-21.1.0/bin;${env:PATH}"
52-
// },
53-
// "cmake.additionalCompilerSearchDirs": [
54-
// "${workspaceFolder:cesium-src}/buildtools/bin",
55-
// "${workspaceFolder:cesium-src}/buildtools/llvm-21.1.0/bin",
56-
// ],
57-
"cmake.cmakePath": "${workspaceFolder}/buildtools/bin/cmake-4.1.1/bin/cmake",
58-
"clangd.path": "${workspaceFolder}/buildtools/llvm-21.1.0/bin/clangd.exe",
53+
"cmake.cmakePath": "${workspaceFolder}/buildtools/opt/cmake-4.1.1/bin/cmake",
54+
"clangd.path": "${workspaceFolder}/buildtools/opt/llvm-21.1.0/bin/clangd.exe",
55+
"clangd.arguments": [
56+
"--compile-commands-dir=${workspaceFolder}/build"
57+
],
5958
"cmake.configureOnOpen": true,
6059
"cmake.configureOnEdit": true,
60+
"cmake.buildBeforeRun": true,
61+
"cmake.launchBehavior": "breakAndReuseTerminal",
6162
// "cmake.buildTask": true,
6263
"terminal.integrated.env.windows": {
63-
"PATH": "${workspaceFolder}/buildtools/bin/zig-0.15.1;${workspaceFolder}/buildtools/llvm-21.1.0/bin;${env:PATH}"
64+
"PATH": "${workspaceFolder}/build/bin;${workspaceFolder}/buildtools/opt/llvm-21.1.0/bin;${env:PATH}"
6465
},
6566
"lldb.verboseLogging": true,
67+
"zig.path": "${workspaceFolder}/buildtools/opt/zig-0.15.1/zig.exe",
68+
"lldb.useNativePDBReader": true,
69+
// "lldb.library": "${workspaceFolder}/buildtools/opt/llvm-21.1.0/bin",
70+
// "zig.debugAdapter": "${workspaceFolder}/buildtools/opt/llvm-21.1.0/bin/lldb"
71+
"zig.debugAdapter": "lldb"
72+
// "lldb.executable": "${workspaceFolder}/buildtools/opt/llvm-21.1.0/bin/lldb.exe",
6673
},
6774
"extensions": {
6875
// See http://go.microsoft.com/fwlink/?LinkId=827846
@@ -89,12 +96,11 @@
8996
"type": "lldb",
9097
"request": "launch",
9198
"name": "Launch",
92-
// "program": "${workspaceFolder}/build/bin/cesium.exe", //build/clang-21.1.0-x86_64-pc-windows-msvc/bin/cesium.exe
99+
// "program": "${workspaceFolder}/build/bin/cesium.exe",
93100
"program": "${command:cmake.launchTargetPath}",
94101
"args": [],
95102
"cwd": "${command:cmake.getLaunchTargetDirectory}",
96-
// "cwd": "${workspaceFolder}",
97-
// "preLaunchTask": "CMake: build"
103+
"console": "integratedTerminal"
98104
}
99105
]
100106
},

0 commit comments

Comments
 (0)