📝 Add docstrings to pipiline
#19
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Docstrings generation was requested by @WSQS. * #7 (comment) The following files were modified: * `main.cpp` * `sdl_wrapper/sdl_wrapper.buffer.cpp` * `sdl_wrapper/sdl_wrapper.pipeline.cpp`
Author
|
Important Review skippedCodeRabbit bot authored PR detected. To trigger a single review, invoke the You can disable this status message by setting the Comment |
Merged
Contributor
|
Here's the code health analysis summary for commits Analysis Summary
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| * destroys the SDL window. | ||
| * Shuts down ImGui SDL3 and SDLGPU backends, destroys the ImGui context, | ||
| * releases the application's association with the GPU device for the window, | ||
| * and destroys the SDL window. |
There was a problem hiding this comment.
warning: 'virtual' is redundant since the function is already declared 'override' [cppcoreguidelines-explicit-virtual-functions]
Suggested change
| * and destroys the SDL window. | |
| void quit(SDL_AppResult result) override |
| * destroys the SDL window. | ||
| * Shuts down ImGui SDL3 and SDLGPU backends, destroys the ImGui context, | ||
| * releases the application's association with the GPU device for the window, | ||
| * and destroys the SDL window. |
There was a problem hiding this comment.
warning: parameter 'result' is unused [misc-unused-parameters]
Suggested change
| * and destroys the SDL window. | |
| virtual void quit(SDL_AppResult /*result*/) override |
|
clang-tidy review says "All clean, LGTM! 👍" |
WSQS
added a commit
that referenced
this pull request
Nov 14, 2025
* feat: add class PileLineWrapper * feat: add pipe line wrapper to User App * refactor: rename class * feat:code rabbit enable auto_apply_labels * fix: add check before release pipeline Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * fix:handle SDL_CreateGPUGraphicsPipeline error * fix:call sdl init before app init * feat: add class gpu wrapper * style: format code with ClangFormat This commit fixes the style issues introduced in 46e77a7 according to the output from ClangFormat. Details: #7 * 📝 Add docstrings to `pipiline` (#8) * 📝 Add docstrings to `pipiline` Docstrings generation was requested by @WSQS. * #7 (comment) The following files were modified: * `main.cpp` * `sdl_wrapper/sdl_callback_implement.cpp` * style: format code with ClangFormat This commit fixes the style issues introduced in 49e577b according to the output from ClangFormat. Details: #8 --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com> * fix:change log * fix:cadd check for gpu wrapper * fix:using gpu wrapper in buffer wrapper * fix:rename variable * fix:change vertex buffer to value semantics * style: format code with ClangFormat This commit fixes the style issues introduced in 9cd5876 according to the output from ClangFormat. Details: #7 * fix: remote typo * break: split implement unit of module * style: format code with ClangFormat This commit fixes the style issues introduced in 9796426 according to the output from ClangFormat. Details: #7 * fix: add log for windows ci * fix: rename log name * fix: Add type * style: format code with ClangFormat This commit fixes the style issues introduced in f75fa22 according to the output from ClangFormat. Details: #7 * fix: Add module unit sdl_wrapper:decl * Fix resource leak (#10) * feat:release gpu before windows * feat:release window from gpu devices --------- Co-authored-by: Sophomore <sophomore@duck.com> * fix: remove todo, the destroy order is defined by shared_ptr * feat: add function create_buffer to GpuWrapper * style: format code with ClangFormat This commit fixes the style issues introduced in 60d5ebd according to the output from ClangFormat. Details: #7 * 📝 Add docstrings to `pipiline` (#9) * 📝 Add docstrings to `pipiline` Docstrings generation was requested by @WSQS. * #7 (comment) The following files were modified: * `main.cpp` * `sdl_wrapper/sdl_callback_implement.cpp` * `sdl_wrapper/sdl_wrapper.buffer.cpp` * style: format code with ClangFormat This commit fixes the style issues introduced in 32e7ade according to the output from ClangFormat. Details: #9 --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com> Co-authored-by: WSQS <17792626+WSQS@users.noreply.github.com> * Add workflow clang-tidy-review * fix:workflow set compiler * fix:install package for ubuntu * fix:add parameter * fix:add parameter * fix:add permission * fix:remove bom * fix:change command * Add workflow Gen pr (#16) * Add workflow * feat: Add permission * feat: change model * feat: add include file * feat: change key word * feat: set workflow in aider * feat: enable verbose * feat: enable verbose * feat: enable verbose * feat: remove bom --------- Co-authored-by: Sophomore <sophomore@duck.com> * feat: let gpu create pipeline * style: format code with ClangFormat This commit fixes the style issues introduced in db03e22 according to the output from ClangFormat. Details: #7 * Remove unused headfile Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * style: format code with ClangFormat This commit fixes the style issues introduced in 721f0ef according to the output from ClangFormat. Details: #7 * fix: change comment * fix: add header file * style: format code with ClangFormat This commit fixes the style issues introduced in d9851ce according to the output from ClangFormat. Details: #7 * fix: remove unused file. * 📝 Add docstrings to `pipiline` (#17) * 📝 Add docstrings to `pipiline` Docstrings generation was requested by @WSQS. * #7 (comment) The following files were modified: * `main.cpp` * `sdl_wrapper/sdl_wrapper.buffer.cpp` * `sdl_wrapper/sdl_wrapper.pipeline.cpp` * style: format code with ClangFormat This commit fixes the style issues introduced in c7383b5 according to the output from ClangFormat. Details: #17 --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com> * fix: from optional to value * feat: add compile command * feat:implement pipeline_wrapper * style: format code with ClangFormat This commit fixes the style issues introduced in b70c22e according to the output from ClangFormat. Details: #7 * fix: shader length error * fix: rename variable * fix: rename function * fix: change shader code * fix: avoid resource leak * fix: change primitive type * 📝 Add docstrings to `pipiline` (#19) * 📝 Add docstrings to `pipiline` Docstrings generation was requested by @WSQS. * #7 (comment) The following files were modified: * `main.cpp` * `sdl_wrapper/sdl_wrapper.buffer.cpp` * `sdl_wrapper/sdl_wrapper.pipeline.cpp` * style: format code with ClangFormat This commit fixes the style issues introduced in 66165a8 according to the output from ClangFormat. Details: #19 --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com> --------- Co-authored-by: Sophomore <sophomore@duck.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docstrings generation was requested by @WSQS.
The following files were modified:
main.cppsdl_wrapper/sdl_wrapper.buffer.cppsdl_wrapper/sdl_wrapper.pipeline.cppThese files were kept as they were
sdl_wrapper/sdl_callback_implement.cppThese file types are not supported
.coderabbit.yaml.github/workflows/clang-tidy-review.yml.github/workflows/cmake-windows.yml.github/workflows/gen-pr.ymlCMakeLists.txtgen-pr.config.ymlsdl_wrapper/CMakeLists.txtsdl_wrapper/sdl_wrapper.app.ixxsdl_wrapper/sdl_wrapper.buffer.ixxsdl_wrapper/sdl_wrapper.decl.ixxsdl_wrapper/sdl_wrapper.gpu.ixxsdl_wrapper/sdl_wrapper.ixxsdl_wrapper/sdl_wrapper.pipeline.ixxℹ️ Note