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

Need Help with Missing Definitions - InterOp Doxygen Documentation Comments #86

Closed
QuillPusher opened this issue May 29, 2023 · 2 comments

Comments

@QuillPusher
Copy link
Contributor

@vgvassilev Adding separate issue alongside PR #85 to add more context.

As discussed during the Weekly Documentation Meeting, please help add missing comments for Doxygen documentation where you can, specifically for

  1. Function Definitions (mostly covered in PR 85)
  2. Parameters ( \param )
  3. Return Values ( \return )
@vgvassilev
Copy link
Contributor

@QuillPusher is that issue resolved?

@QuillPusher
Copy link
Contributor Author

No, but this is an optional issue.

You (@vgvassilev) mentioned during our docs meeting that you could also help add some definitions (code comments) for the CppInterOp Documentation.

I took all the info from Baidyanath's session and added the comments (PR #85 ), but there's still room for improvement (e.g., better \param and \return values).

On the other hand, you've already reviewed my comments/definitions in PR #85 , so if no big area seemed lacking then this issue can be closed (and we can aim for improvement in the next documentation iteration).

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

2 participants