azure-sdk-for-c icon indicating copy to clipboard operation
azure-sdk-for-c copied to clipboard

Published 20 hours ago • verified publisher icon Azure

Add preconditions to the doxygen docs

Open danewalton opened this issue 4 years ago • 4 comments

Discovered the @pre tag to list preconditions for functions. Would look something like:

image

image

Is this something we would want to add to all the API's?

danewalton avatar Sep 14 '20 20:09 danewalton

Nice!

Is this something we would want to add to all the API's?

I think we should add them. Good idea.

ahsonkhan avatar Sep 15 '20 03:09 ahsonkhan

@RickWinter, @antkmsft, @vhvb1989, @JeffreyRichter - thoughts?

ahsonkhan avatar Sep 15 '20 03:09 ahsonkhan

I really like this too!

JeffreyRichter avatar Sep 15 '20 04:09 JeffreyRichter

Tackling IOT side of it with #1619

danewalton avatar Feb 25 '21 01:02 danewalton

Hi @danewalton, we deeply appreciate your input into this project. Regrettably, this issue has remained inactive for over 2 years, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.

github-actions[bot] avatar Mar 15 '24 18:03 github-actions[bot]