From: "Frank Ch. Eigler" <fche@redhat.com>
To: Milian Wolff <mail@milianw.de>
Cc: elfutils-devel@sourceware.org
Subject: Re: Questions regarding debuginfod.h API
Date: Sat, 16 Apr 2022 11:03:58 -0400 [thread overview]
Message-ID: <20220416150358.GA19820@redhat.com> (raw)
In-Reply-To: <15044726.Ck1BFTr2H8@milian-workstation>
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
prev parent reply other threads:[~2022-04-16 15:04 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-08 12:44 Milian Wolff
2022-04-08 13:44 ` Frank Ch. Eigler
2022-04-08 19:09 ` Milian Wolff
2022-04-08 19:44 ` Frank Ch. Eigler
2022-04-08 19:50 ` Milian Wolff
2022-04-09 13:44 ` Expanding control over debuginfod usage from dwfl [was: Re: Questions regarding debuginfod.h API] Milian Wolff
2022-07-06 18:28 ` Milian Wolff
2022-07-06 18:40 ` Frank Ch. Eigler
2022-07-06 19:37 ` Milian Wolff
2022-07-06 19:41 ` Frank Ch. Eigler
2022-07-06 19:44 ` Milian Wolff
2022-07-06 19:54 ` Frank Ch. Eigler
2022-04-16 15:03 ` Frank Ch. Eigler [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220416150358.GA19820@redhat.com \
--to=fche@redhat.com \
--cc=elfutils-devel@sourceware.org \
--cc=mail@milianw.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).