Hi all, I'm pretty much with Pau here: On Wed, Feb 26, 2025 at 01:36:18PM +0100, Pau Espin Pedrol wrote:
Moreover, I don't really see a good reason for moving documentation to header files other than: * "My foobar editor decides it only parses header files" * A user may want to inspect documentation through installed -dev packages in /usr/include/osmocom/.
[...]
There's also some benefits of having it in .c files: * Documentation is next to the implementation, so one can quickly validate the implementation and formal behavior of the function * Way shorter header files wich allow seing the full set of APIs available with a quick glance at the screen. * Functions can be declared in several headers/places (we hopefully don't do this).
So not like I have a strong opinion on this, but I don't think it really makes sense to change the current approach right now?
I also don't have a super strong opinion if we were about to create a policy for software that hasn't been written yet. But given we have a massive codebase with comments in the .c files, I do not think it is a wise investment to convert the entire codebase. Regards, Harald -- - Harald Welte <laforge@osmocom.org> https://laforge.gnumonks.org/ ============================================================================ "Privacy in residential applications is a desirable marketing option." (ETSI EN 300 175-7 Ch. A6)