SOFA is very unusual for a C project in that it includes its documentation in the .c implementation files, not in the .h header files. This is the opposite of standard procedure in C, where generally a system library may have the header files (which also serve as usage documentation) and compiled binaries, but the original .c files are not available.
- IDEs/editors that provide pop-up help about functions are unable to do so.
- Tools that want to generate wrappers and include the documentation, or use the extra information about in/out variables contained therein, can not do so without the full source.
At the end of the day, this is probably a minor point relative to the effort it would take to fix it, but its rather irksome.
SOFA is very unusual for a C project in that it includes its documentation in the
.cimplementation files, not in the.hheader files. This is the opposite of standard procedure in C, where generally a system library may have the header files (which also serve as usage documentation) and compiled binaries, but the original.cfiles are not available.At the end of the day, this is probably a minor point relative to the effort it would take to fix it, but its rather irksome.