Generate and publish interface documentation

[TheHubbit]

This is an enhancement request. It would be very helpful to generate and publish a reference documentation on the Image3dAPI. Maybe run doxygen and create a github page from the generated html?

[forderud]

Sounds like a good idea @TheHubbit. The interfaces are defined in https://github.com/MedicalUltrasound/Image3dAPI/blob/master/Image3dAPI/IImage3d.idl .
Please feel free to submit a pull-request with a proposal for doxygen setup if you have an idea.

[TheHubbit]

I tried doxygen but it didn't produce anything helpful from IImage3d.idl (only picked up ProbeInfo struct). Next I checked in Python, but here too the doc members are all empty in the wrapped objects. The helpstring comments show up in the object browser of Visual Studio but I don't know how to get a API reference from it. Maybe someone with more MS background can help?

[forderud]

Example of how to access the API documentation also from Python:
print(Image3dAPI.IImage3dFileLoader.LoadFile.__doc__) will print the following to stdout:

Load proprietary image file.
The file might already by opened elsewhere, so no exclusive locks can be taken.
The function shall return quickly with an informative error message (for debugging) in case of failure.

I'm not sure how useful this is from a documentation point of view. But the information is at least available.

[forderud]

I only have experience with Doxygen for C++ codebases myself. Therefore, I don't know if it's possible to tweak Doxygen to properly parse IDL files. Sorry...