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

Cleanup of Documentation, Organization, and the Routing System #31

Closed
3 of 5 tasks
CalebLItalien opened this issue May 15, 2024 · 0 comments
Closed
3 of 5 tasks
Assignees

Comments

@CalebLItalien
Copy link
Member

CalebLItalien commented May 15, 2024

Details

Clean up the documentation in all files, making sure they can all generate HTML using cargo doc --open. Then, reorganize the IR files into a structure that makes more sense, given that #24 will eventually be completed. Finally, updating the router system so then we can export the public API.

Issue Type

  • Feature
  • Bugfix
  • Documentation
  • Refactoring
  • Other:

Requirements

  • Documentation for all files that are currently implemented, HTML compliant
  • Reorganization of ir into a system that makes more sense/is more verbose
    • Rename function names to very closely match LLVM's API naming, as much as is possible
  • Updated router.rs files

Notes

@CalebLItalien CalebLItalien moved this to Todo in SafeLLVM May 15, 2024
@CalebLItalien CalebLItalien self-assigned this May 27, 2024
@CalebLItalien CalebLItalien moved this from Todo to In Progress in SafeLLVM May 27, 2024
@CalebLItalien CalebLItalien mentioned this issue Jun 1, 2024
@CalebLItalien CalebLItalien moved this from In Progress to Done in SafeLLVM Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

1 participant