Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

account for automatic code transformation, generate documentation #15

Open
3 tasks
haxscramper opened this issue Oct 8, 2021 · 0 comments
Open
3 tasks
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@haxscramper
Copy link
Owner

haxscramper commented Oct 8, 2021

Due to the nature of the problem, some convoluted code transformation procedures are required, like merging whole analyzed source code in graph and extracting elements back again. Automatic renames, dropped enum values due to nim requirements and so on result in the API that is different from the original one. These differences must be automatically accounted for, and final produced documentation should make it clear how to use the library for someone who is already familiar with Cxx counterpart.

  • Re-export types from merged modules. Keep track of what file provided forward declarations and which ones contained real one, and re-export documentation only from the latter.
  • Dropped enum value duplicates
  • Unspecified default template parameters
@haxscramper haxscramper added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant