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

Adding documentation. #3

Open
SharonIV0x86 opened this issue Apr 17, 2024 · 0 comments
Open

Adding documentation. #3

SharonIV0x86 opened this issue Apr 17, 2024 · 0 comments

Comments

@SharonIV0x86
Copy link
Collaborator

Currently the Vector container defined in include/Vector.h is mission detailed documentation, i will be working on adding documentation myself maybe directly with readme files or using gituhb wiki, but currently we only have the usage example of vector.

Another idea is to add comment block over each function in the Vector.h but that will significantly increase the LoCs so this is kept as a future idea when the functions/methods definitions and declarations are moved into separate files .c and .h files, or a static library used is added.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant