Dronecode / camera-manager

Camera Manager for interfacing cameras with the Dronecode platform
https://camera-manager.dronecode.org/en/
Apache License 2.0
63 stars 51 forks source link

Document code using Doxygen standard and generate code documentation #21

Open otaviobp opened 7 years ago

lbegani commented 6 years ago

@hamishwillee Any opinion on this?

hamishwillee commented 6 years ago

I have an opinion on everything :-).

I like doxygen for documenting public APIs as it makes it easy to keep docs in sync with code. But CSD doesn't have much in the way of public APIs so I'm ambivalent.

For internal docs generally I think you're better off putting effort into clean design and well named types/objects - so the code is somewhat self-documenting.

Probably not. I tend to like doxygen for documenting public APIs because