"Internal" functions

Jim Easterbrook <[email protected]> Thu, 20 Apr 2023 17:14:23 +0100
Newsgroups gmane.comp.multimedia.gphoto.devel
Message-ID <[email protected]>
Hi all,

I like to exclude gphoto2's "internal" functions from the Python 
interface I maintain. However, it's not always clear which functions are 
intended for "front end" use. For example, only today I saw a comment in 
gphoto2-file.h that gp_file_append is for use by camera drivers only. 
(No one's going to write a camera driver in Python.) There are also 
comments about other functions being phased out in future, but it's not 
clear which. None of this is made clear in the API documentation.

I suppose what I'm asking for is more thorough documentation. Something 
more programmatic, such as a #define to include or exclude "internal" 
functions, would be useful but probably more work.

On the subject of documentation, if the Doxygen function descriptions 
were in the .h header files instead of the .c source then it would be 
easier to include them in the Python interface, as SWIG has an option to 
parse Doxygen. (SWIG generates an interface from the .h files only.)

-- 
Jim Easterbrook                 <http://www.jim-easterbrook.me.uk/>