From: Joerg Sonnenberger <joerg@britannica.bec.de>
To: discuss@mdocml.bsd.lv
Subject: Re: Library manpages per-function or per-library?
Date: Wed, 12 Nov 2014 15:51:27 +0100 [thread overview]
Message-ID: <20141112145127.GA28857@britannica.bec.de> (raw)
In-Reply-To: <54636E8E.3010007@bsd.lv>
On Wed, Nov 12, 2014 at 03:28:30PM +0100, Kristaps Dzonsons wrote:
> I thought I'd put this question up for future searches, as it
> confuses me and no doubt confuses others, as well. In short, when
> writing a library, does one document each function in a separate
> mdoc(7) page, or all functions in one big one? Or perhaps, grouped
> by utility? Or grouped by header file?
One man page documenting the general API design and one man page per
function group.
Joerg
--
To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv
next prev parent reply other threads:[~2014-11-12 14:51 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-11-12 14:28 Kristaps Dzonsons
2014-11-12 14:51 ` Joerg Sonnenberger [this message]
2014-11-20 2:02 ` Ingo Schwarze
2014-11-20 2:10 ` Guy Harris
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=20141112145127.GA28857@britannica.bec.de \
--to=joerg@britannica.bec.de \
--cc=discuss@mdocml.bsd.lv \
/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 NNTP newsgroup(s).