Re: Adding doxygen style comments to header files

BTW, for me, the argument isn't so much doxygen. I never use that HTML and if anyone does, please raise your hand. For me it's about reading the source tree. (I would very much enjoy dropping the weird doxygen syntax and markers) There may also be the aspect of the license applying only to the .c files. IIUC .h files are considered flat compiling necessity, not substance of a project. I'm not sure about this / don't feel strong about that aspect. My two main strong opinions are opposing each other: 1. when hacking on our code, i enjoy that a .h has only the terse list of actual API without long comments in-between. It makes it easy to get a good big picture of the API very rapidly. The doc is just one ctags jump away. 2. when using other libraries, i enjoy when the .h file already explains everything i need to know about the function arguments. Because I don't have the .c file anywhere near. A good example for both is talloc. Very useful to read the .h for docs. But it also took me a very long time to get a big picture of the API. Years later I was still finding functions i wished i had known about sooner. My preference for either is not strong enough to want to change how we're doing it in osmocom. ~N