fix: fix image module docs #989
Open
Conversation
This file contains 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
cieslarmichal
requested changes
Nov 21, 2024
Comment on lines
-44
to
+45
| PROJECT_NAME = "Faker C++" | ||
| PROJECT_NAME = "My Project" |
There was a problem hiding this comment.
why did you change it to my project?
| @@ -60,19 +61,25 @@ PROJECT_BRIEF = | |||
| # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy | |||
| # the logo to the output directory. | |||
|
|
|||
| PROJECT_LOGO = docs/public/logo.png | |||
Comment on lines
+9
to
+11
| /** | ||
| * @brief Namespace for image-related functionalities. | ||
| */ |
There was a problem hiding this comment.
no need to document namespace, please remove
Comment on lines
+18
to
+29
| Animals, ///< Images related to animals. | ||
| Business, ///< Images related to business. | ||
| Cats, ///< Images of cats. | ||
| City, ///< Images of cityscapes. | ||
| Food, ///< Images of food items. | ||
| Nightlife, ///< Images of nightlife scenes. | ||
| Fashion, ///< Images related to fashion. | ||
| People, ///< Images of people. | ||
| Nature, ///< Images of nature. | ||
| Sports, ///< Images related to sports. | ||
| Technics, ///< Images of technical items. | ||
| Transport ///< Images of transport and vehicles. |
| * @param width The width of the image. Default is 640. | ||
| * @param height The height of the image. Default is 480. | ||
| * @param category The optional category of the image. | ||
| * @return std::string The generated image URL. |
There was a problem hiding this comment.
why did you remove code example?
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.
Pull Request Description
Fixes Issue #954
This PR improves the Doxygen documentation for
image.cppandimage.h. It adds detailed comments for functions, enums, and constants in thefaker::imagenamespace, ensuring clear and comprehensive documentation.Key Changes
image.h.ImageCategoryenum with descriptions for each category.image.cppfor clarity.How to Verify
image.cppandimage.hin the generateddocs/htmlfiles.This resolves Issue #954.