📝 Add docstrings to feat/asset-back

[coderabbitai]

Docstrings generation was requested by @Thyodas.

• feat: add back-end for Asset management #63 (comment)

The following files were modified:

• editor/main.cpp
• editor/src/DocumentWindows/AssetManagerWindow.cpp
• editor/src/DocumentWindows/AssetManagerWindow.hpp
• editor/src/Editor.hpp
• editor/src/SceneManagerBridge.cpp
• editor/src/backends/ImGuiBackend.cpp
• engine/src/assets/Asset.hpp
• engine/src/assets/AssetCatalog.cpp
• engine/src/assets/AssetCatalog.hpp
• engine/src/assets/AssetImporter.cpp
• engine/src/assets/AssetImporter.hpp
• engine/src/assets/AssetImporterBase.hpp
• engine/src/assets/AssetImporterContext.cpp
• engine/src/assets/AssetImporterContext.hpp
• engine/src/assets/AssetLocation.cpp
• engine/src/assets/AssetLocation.hpp
• engine/src/assets/AssetRef.hpp
• engine/src/assets/Assets/Model/Model.hpp
• engine/src/assets/Assets/Model/ModelImporter.hpp
• engine/src/assets/Assets/Texture/Texture.hpp
• engine/src/assets/Assets/Texture/TextureImporter.hpp
• engine/src/assets/FilenameValidator.hpp
• engine/src/assets/ValidatedName.hpp
• engine/src/renderer/GraphicsBackends/opengl/OpenGlBuffer.hpp
• engine/src/renderer/GraphicsBackends/opengl/OpenGlTexture2D.cpp
• engine/src/renderer/GraphicsBackends/opengl/OpenGlTexture2D.hpp
• engine/src/renderer/Renderer2D.cpp
• engine/src/renderer/Texture.cpp
• tests/test_main.cpp

These files were ignored

• tests/engine/assets/AssetLocation.test.cpp
• tests/engine/assets/AssetName.test.cpp
• tests/renderer/Buffer.test.cpp
• tests/renderer/Framebuffer.test.cpp
• tests/renderer/RendererAPI.test.cpp
• tests/renderer/Shader.test.cpp
• tests/renderer/Texture.test.cpp
• tests/renderer/VertexArray.test.cpp

These file types are not supported

• .gitignore
• CMakeLists.txt
• config/default-layout.ini
• editor/CMakeLists.txt
• engine/CMakeLists.txt
• scripts/CMakeCPackOptions.cmake.in
• tests/CMakeLists.txt
• tests/engine/CMakeLists.txt
• tests/renderer/CMakeLists.txt
• vcpkg.json

ℹ️ Note

CodeRabbit cannot perform edits on its own pull requests yet.

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.