Questions regarding debuginfod.h API

[Frank Ch. Eigler]

Hi -

> > > My `debuginfod.h` also does not show any (useful) inline API
> > > documentation for most of that file. Could this please be improved?
> > > The doxygen for dwfl is great and can be read directly together with
> > > the code,
> > 
> > As they say, patches welcome. :-) The header contains some curt
> > comments documenting each function.
> 
> Would you be OK with me simply copying over the contents from the man page 
> over to doxygen? Or is there a better process in place to prevent such kind of 
> documentation duplication? I would have expected that the man pages for API 
> documentation are generated from e.g. doxygen which does not seem to be the 
> case here?

Correct, elfutils does not have much API documentation generally.  The
debuginfod parts are a recent addition that buck that trend. :-) I
don't have a strong opinion about doxygen syntax markup or tooling
dependence, per se.  OTOH I would not want to see documentation
duplication or loss of man pages.

- FChE