generate doc #37
Merged
generate doc #37
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
Enhanced the `EnumGenerator` to include documentation comments for enumerations, using the newly introduced `appendDoc` function. Updated models to handle enum entries as triples with documentation, and added utilities to extract and process documentation strings from YAML definitions. Expanded enumerations with detailed inline comments for better context.
Replaced function and method references in documentation with Markdown-style links for better readability. Added a helper function to convert formatted string references into compatible Markdown links in the YamlModel domain logic.
Updated comment formatting across several files to ensure proper spacing before closing comment tags. This improves code clarity and maintains consistent documentation style.
The debug download tasks for Android architectures were removed as they are no longer needed. This simplifies the build script and reduces unnecessary complexity, improving maintainability.
Standardize string extension usage for clarity and reusability in `YamlModel`. Update documentation to replace inline code references with proper Dokka-style links for enhanced readability.
Standardize string extension usage for clarity and reusability in `YamlModel`. Update documentation to replace inline code references with proper Dokka-style links for enhanced readability.
Added detailed documentation to various functions for better clarity and usability. Introduced a new `FunctionArgument` type alias to streamline function argument handling, including optional documentation. Enhanced internal processing to support and propagate argument and function-level documentation effectively.
Replaced `Type` with `FunctionReturnType` for better structure and added support for detailed return type documentation. Updated templates and function generation logic to handle the new structure consistently. Minor adjustments to build configurations and library dependencies.
Extended NativeModel.Pointer to include optional documentation and updated relevant conversion and generation logic to handle documentation consistently. Adjusted type generation to embed documentation comments for better understanding of generated classes.
Centralize member handling by extracting `getMembers` function, reducing duplication in structure generation. Introduce the `doc` property to NativeModel structures and improve interface definition readability using `templateBuilder`. Additionally, include detailed documentation for various WGPU-related structures.
This update introduces padding fields to various WGPU struct layouts to maintain proper memory alignment. It ensures compatibility and correctness when interfacing with native libraries requiring strict data alignment.
Enhanced the callback model to include an optional `doc` field. Updated relevant functions and templates to utilize and process callback documentation where applicable. This improves clarity and maintainability of generated code.
ygdrasil-io
added a commit
that referenced
this pull request
Feb 9, 2025
* Add support for enum documentation and improve type handling Enhanced the `EnumGenerator` to include documentation comments for enumerations, using the newly introduced `appendDoc` function. Updated models to handle enum entries as triples with documentation, and added utilities to extract and process documentation strings from YAML definitions. Expanded enumerations with detailed inline comments for better context. * Refactor documentation references and enhance string parsing. Replaced function and method references in documentation with Markdown-style links for better readability. Added a helper function to convert formatted string references into compatible Markdown links in the YamlModel domain logic. * Fix comment formatting in multiple files Updated comment formatting across several files to ensure proper spacing before closing comment tags. This improves code clarity and maintains consistent documentation style. * Remove redundant debug download tasks from build script The debug download tasks for Android architectures were removed as they are no longer needed. This simplifies the build script and reduces unnecessary complexity, improving maintainability. * Refactor string handling and improve documentation format. Standardize string extension usage for clarity and reusability in `YamlModel`. Update documentation to replace inline code references with proper Dokka-style links for enhanced readability. * Refactor string handling and improve documentation format. Standardize string extension usage for clarity and reusability in `YamlModel`. Update documentation to replace inline code references with proper Dokka-style links for enhanced readability. * Improve function documentation and enhance type handling Added detailed documentation to various functions for better clarity and usability. Introduced a new `FunctionArgument` type alias to streamline function argument handling, including optional documentation. Enhanced internal processing to support and propagate argument and function-level documentation effectively. * Refactor function return type handling across modules Replaced `Type` with `FunctionReturnType` for better structure and added support for detailed return type documentation. Updated templates and function generation logic to handle the new structure consistently. Minor adjustments to build configurations and library dependencies. * Add support for documenting NativeModel.Pointer and related types Extended NativeModel.Pointer to include optional documentation and updated relevant conversion and generation logic to handle documentation consistently. Adjusted type generation to embed documentation comments for better understanding of generated classes. * Refactor structure generation logic and add documentation support Centralize member handling by extracting `getMembers` function, reducing duplication in structure generation. Introduce the `doc` property to NativeModel structures and improve interface definition readability using `templateBuilder`. Additionally, include detailed documentation for various WGPU-related structures. * Add padding to WGPU struct layouts to ensure alignment This update introduces padding fields to various WGPU struct layouts to maintain proper memory alignment. It ensures compatibility and correctness when interfacing with native libraries requiring strict data alignment. * Add support for callback documentation handling Enhanced the callback model to include an optional `doc` field. Updated relevant functions and templates to utilize and process callback documentation where applicable. This improves clarity and maintainability of generated code. * add html and markdown documentation
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.
No description provided.