netmq icon indicating copy to clipboard operation
netmq copied to clipboard

Some kind of API or Reference documentation?

Open xaedes opened this issue 4 years ago • 3 comments

Is there some kind of API reference? netmq.readthedocs.io is just prosa and examples.

The code contains lots of documenting comments, where is the autogenerated documentation from this?

xaedes avatar Oct 29 '20 23:10 xaedes

The ZeroMQ guide is the best foundational reference for ZeroMQ in general.

netmq.readthedocs.io provides some code samples specific to the particular .NET binding.

There's currently no browseable documentation generated from the doc comments, though they should be appearing in your IDE when consuming the project via a NuGet package.

drewnoakes avatar Oct 30 '20 00:10 drewnoakes

Agreed, the ZeroMQ guide is a nice read.

It would be really awesome if the online documentation would include html documentation generated by the already existing sand castle project =)

An API reference browseable without huge IDE is a benefit for every great library.

xaedes avatar Oct 30 '20 00:10 xaedes

This issue has been automatically marked as stale because it has not had activity for 365 days. It will be closed if no further activity occurs within 56 days. Thank you for your contributions.

stale[bot] avatar Apr 17 '22 03:04 stale[bot]