From: Michael Haggerty <mhagger@alum.mit.edu>
To: Andreas Ericsson <ae@op5.se>
Cc: Jeff King <peff@peff.net>, Junio C Hamano <gitster@pobox.com>,
git@vger.kernel.org
Subject: Using doxygen (or something similar) to generate API docs [was [PATCH 4/4] Add a function string_list_longest_prefix()]
Date: Mon, 10 Sep 2012 21:21:12 +0200 [thread overview]
Message-ID: <504E3DA8.7040906@alum.mit.edu> (raw)
In-Reply-To: <504E27D7.8010505@op5.se>
I'm renaming this thread so that the bikeshedding can get over ASAP.
On 09/10/2012 07:48 PM, Andreas Ericsson wrote:
> On 09/10/2012 06:33 PM, Jeff King wrote:
>> On Mon, Sep 10, 2012 at 09:24:17AM -0700, Junio C Hamano wrote:
>>> Michael Haggerty <mhagger@alum.mit.edu> writes:
>>>> Also, better documentation in header files could enable the automatic
>>>> generation of API docs (e.g., via doxygen).
>>>
>>> Yeah, perhaps you may want to look into doing an automated
>>> generation of Documentation/technical/api-*.txt files out of the
>>> headers.
>>
>> I was just documenting something in technical/api-* the other day, and
>> had the same feeling. I'd be very happy if we moved to some kind of
>> literate-programming system. I have no idea which ones are good or bad,
>> though. I have used doxygen, but all I remember is it being painfully
>> baroque. I'd much rather have something simple and lightweight, with an
>> easy markup format. For example, this:
>>
>> http://tomdoc.org/
>>
>> Looks much nicer to me than most doxygen I've seen. But again, it's been
>> a while, so maybe doxygen is nicer than I remember.
I don't have a personal preference for what system is used. I mentioned
doxygen only because it seems to be a well-known example.
>From a glance at the URL you mentioned, it looks like TomDoc is only
applicable to Ruby code.
> Doxygen has a the very nifty feature of being able to generate
> callgraphs though. We use it extensively at $dayjob, so if you need a
> hand building something sensible out of git's headers, I'd be happy
> to help.
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 :-)
Most importantly, having a convenient system of converting header
comments into documentation would hopefully motivate other people to add
better header comments in the first place, and motivate reviewers to
insist on them. It's shocking (to me) how few functions are documented,
and how often I have to read masses of C code to figure out what a
function is for, its pre- and post-conditions, its memory policy, etc.
Often I find myself having to read functions three layers down the call
tree to figure out the behavior of the top-layer function. I try to
document things as I go, but it's only a drop in the bucket.
> libgit2 uses doxygen btw, and has done since the start. If we ever
> merge the two, it would be neat to use the same.
That would be a nice bonus.
Michael
--
Michael Haggerty
mhagger@alum.mit.edu
http://softwareswirl.blogspot.com/
next prev parent reply other threads:[~2012-09-10 19:21 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 ` Michael Haggerty [this message]
2012-09-10 21:56 ` Using doxygen (or something similar) to generate API docs [was [PATCH 4/4] Add a function string_list_longest_prefix()] Jeff King
2012-09-10 22:09 ` Michael Haggerty
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=504E3DA8.7040906@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 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).