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

function names are not listed in API Documents #19

Closed
ami-GS opened this issue Sep 15, 2018 · 2 comments
Closed

function names are not listed in API Documents #19

ami-GS opened this issue Sep 15, 2018 · 2 comments

Comments

@ami-GS
Copy link

ami-GS commented Sep 15, 2018

in API document herehttp://cdds.io/docs/pdf/cdds.pdf doesn't have function name.
Which lists only return value and parameters. How can I associate these informations with appropriate functions?
For example, dds_waitset_wait() is missing in the document.

@eboasson
Copy link
Contributor

Wow, that's an interesting observation!

I suspect it has something to do with doxygen being unable to deal with the annotations for Microsoft's static analyzer (SAL2 annotations), but that is only a guess.

The obvious temporary workaround is to look in the header files themself, as those are the source for that section of the PDF file. For example, the dds_waitset_wait() function description can is here: https://github.com/eclipse/cyclonedds/blob/2a67df48fc2af1c1cca449e02cc318f1222b4480/src/core/ddsc/include/ddsc/dds.h#L2087 (and in an installed version of Cyclone DDS, it would be simply include/ddsc/dds.h).

@ami-GS
Copy link
Author

ami-GS commented Sep 29, 2018

@eboasson
Thanks! it would be really helpful :)

@ami-GS ami-GS closed this as completed Sep 29, 2018
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