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

Vvenkatesan/doxygen #32

Merged
merged 23 commits into from
Mar 26, 2025
Merged

Vvenkatesan/doxygen #32

merged 23 commits into from
Mar 26, 2025

Conversation

vvenkates27
Copy link
Contributor

Adding Doxyfile to autogenerate Documentation

  • User Doxygen compatible API documentation to easily pick up documentation.

@vvenkates27 vvenkates27 force-pushed the vvenkatesan/Doxygen branch from a074461 to 68b4eb2 Compare March 16, 2025 00:57
@vvenkates27 vvenkates27 force-pushed the vvenkatesan/Doxygen branch from 68b4eb2 to b417b20 Compare March 16, 2025 22:52
@vvenkates27 vvenkates27 force-pushed the vvenkatesan/Doxygen branch from b417b20 to 52e50de Compare March 16, 2025 22:53
@vvenkates27 vvenkates27 force-pushed the vvenkatesan/Doxygen branch from 87c4e6d to 2698d98 Compare March 17, 2025 03:21
@vvenkates27 vvenkates27 force-pushed the vvenkatesan/Doxygen branch from 2698d98 to a6af3c6 Compare March 17, 2025 03:38
@vvenkates27 vvenkates27 requested a review from mkhazraee March 17, 2025 03:43
vvenkates27 and others added 23 commits March 26, 2025 00:02
Adding doxygen sytle headers for NIXL APIs and
descriptors. Generate docs with doxygen Doxyfile

This version just focuses on the NB APIS for NIXL

Signed-off-by: Vishwanath Venkatesan <[email protected]>
Spell check errors addressed.

Signed-off-by: Vishwanath Venkatesan <[email protected]>
Addressing build errors

Signed-off-by: Vishwanath Venkatesan <[email protected]>
Fixing the accidentally removed comment for copyright

Signed-off-by: Vishwanath Venkatesan <[email protected]>
Doxygen documentation for NIXL architecture with pictures.

Signed-off-by: Vishwanath Venkatesan <[email protected]>
nixlBlobDesc and nixlBasicDesc are descriptors not list
fixing that.

Signed-off-by: Vishwanath Venkatesan <[email protected]>
Some more description cleanup for Descriptor.

Signed-off-by: Vishwanath Venkatesan <[email protected]>
Signed-off-by: Timothy Stamler <[email protected]>
Some more description cleanup for Descriptor.

Signed-off-by: Vishwanath Venkatesan <[email protected]>
Co-authored-by: Artem Polyakov <[email protected]>
Co-authored-by: Timothy Stamler <[email protected]>
Fix trailing whitespace introduced by github.

Signed-off-by: Vishwanath Venkatesan <[email protected]>
Fix the spell error.

Signed-off-by: Vishwanath Venkatesan <[email protected]>
@mkhazraee mkhazraee force-pushed the vvenkatesan/Doxygen branch from 89da514 to 6cf2b3c Compare March 26, 2025 07:03
@mkhazraee mkhazraee merged commit f751b26 into main Mar 26, 2025
6 checks passed
@mkhazraee mkhazraee deleted the vvenkatesan/Doxygen branch March 26, 2025 07:17
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants