From: Michael Haggerty <mhagger@alum.mit.edu>
To: Jeff King <peff@peff.net>
Cc: Andreas Ericsson <ae@op5.se>, Junio C Hamano <gitster@pobox.com>,
git@vger.kernel.org
Subject: Re: Using doxygen (or something similar) to generate API docs [was [PATCH 4/4] Add a function string_list_longest_prefix()]
Date: Tue, 11 Sep 2012 00:09:30 +0200 [thread overview]
Message-ID: <504E651A.4030401@alum.mit.edu> (raw)
In-Reply-To: <20120910215633.GB1537@sigill.intra.peff.net>
On 09/10/2012 11:56 PM, Jeff King wrote:
> On Mon, Sep 10, 2012 at 09:21:12PM +0200, Michael Haggerty wrote:
>> My plate is full. If you are able to work on this, it would be awesome.
>> As far as I'm concerned, you are the new literate documentation czar :-)
>
> Lucky me? :)
I was nominating Andreas, who rashly volunteered to help. But don't
feel left out; there's enough work to go around :-)
> I think I'll leave it for the moment, and next time I start to add some
> api-level documentation I'll take a look at doxygen-ating them and see
> how I like it. And I'd invite anyone else to do the same (in doxygen, or
> whatever system you like -- the best way to evaluate a tool like this is
> to see how your real work would look).
I agree with that. A very good start would be to mark up a single API
and build the docs (by hand if need be) using a proposed tool. This
will let people get a feel for (1) what the markup has to look like and
(2) what they get out of it.
Michael
--
Michael Haggerty
mhagger@alum.mit.edu
http://softwareswirl.blogspot.com/
next prev parent reply other threads:[~2012-09-10 22:09 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-09-09 5:53 [PATCH 0/4] Add some string_list-related functions Michael Haggerty
2012-09-09 5:53 ` [PATCH 1/4] Add a new function, string_list_split_in_place() Michael Haggerty
2012-09-09 9:35 ` Junio C Hamano
2012-09-10 4:45 ` Michael Haggerty
2012-09-10 5:47 ` Junio C Hamano
2012-09-10 11:48 ` Michael Haggerty
2012-09-10 16:09 ` Junio C Hamano
2012-09-09 5:53 ` [PATCH 2/4] Add a new function, filter_string_list() Michael Haggerty
2012-09-09 9:40 ` Junio C Hamano
2012-09-10 8:58 ` Michael Haggerty
2012-09-09 5:53 ` [PATCH 3/4] Add a new function, string_list_remove_duplicates() Michael Haggerty
2012-09-09 9:45 ` Junio C Hamano
2012-09-10 9:15 ` Michael Haggerty
2012-09-09 5:53 ` [PATCH 4/4] Add a function string_list_longest_prefix() Michael Haggerty
2012-09-09 9:54 ` Junio C Hamano
2012-09-10 10:01 ` Michael Haggerty
2012-09-10 16:24 ` Junio C Hamano
2012-09-10 16:33 ` Jeff King
2012-09-10 17:48 ` Andreas Ericsson
2012-09-10 19:21 ` Using doxygen (or something similar) to generate API docs [was [PATCH 4/4] Add a function string_list_longest_prefix()] Michael Haggerty
2012-09-10 21:56 ` Jeff King
2012-09-10 22:09 ` Michael Haggerty [this message]
2012-09-11 1:01 ` Andreas Ericsson
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=504E651A.4030401@alum.mit.edu \
--to=mhagger@alum.mit.edu \
--cc=ae@op5.se \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.