On Thu, Sep 27, 2018 at 10:36:11AM -0700, Junio C Hamano wrote:
> Jeff King writes:
>
> > If you're interested in pulling documentation out of the header files
> > and generating asciidoc from it, I'm happy to at least try keeping it up
> > to date. When we started putting this information into
Jeff King writes:
> If you're interested in pulling documentation out of the header files
> and generating asciidoc from it, I'm happy to at least try keeping it up
> to date. When we started putting this information into header files, we
> used "/**" to start the comment, as a special marker to
On Wed, Sep 26 2018, Stefan Beller wrote:
> On Wed, Sep 26, 2018 at 1:44 PM Ævar Arnfjörð Bjarmason
> wrote:
>
>> > And if we were going to generate something external, would it make more
>> > sense to write in a structured format like doxygen? I am not a big fan
>> > of it myself, but at
On Wed, Sep 26, 2018 at 11:34:04PM -0700, Jonathan Nieder wrote:
> > We already have the /** convention I mentioned above. Could we have
> > another micro-format like:
> >
> > /** API:strbuf - working with strings */
> >
> > in each header file? That would make generating such an index pretty
>
Hi,
Jeff King wrote:
> On Wed, Sep 26, 2018 at 10:44:33PM +0200, Ævar Arnfjörð Bjarmason wrote:
>> In terms of getting an overview it's indistinguishable from
>> comments. I.e. there's nothing like an index of:
>>
>> man git-api-strbuf ==> working with strings
>> man
On Wed, Sep 26, 2018 at 10:44:33PM +0200, Ævar Arnfjörð Bjarmason wrote:
> My bias here is that I've also contributed actively to the perl project
> in the past, and with that project you can get an overview of *all* of
> the docs by typing:
>
> man perl
>
> That includes stuff like
On Wed, Sep 26, 2018 at 1:44 PM Ævar Arnfjörð Bjarmason
wrote:
> > And if we were going to generate something external, would it make more
> > sense to write in a structured format like doxygen? I am not a big fan
> > of it myself, but at least from there you can generate a more richly
> >
Ævar Arnfjörð Bjarmason writes:
> So in terms of implementation I'm a big fan of the perl.git approach of
> having these docs as comments before the function implementation in the
> *.c file.
>
> It means you can't avoid seeing it or updating it when source
> spelunking, and it leaves header
[Changing subject because this stopped being about Stefan's patches a
while ago]
On Wed, Sep 26 2018, Jeff King wrote:
> On Wed, Sep 26, 2018 at 08:43:14PM +0200, Ævar Arnfjörð Bjarmason wrote:
>
>> While we're on that subject, I'd much prefer if these technical docs and
>> other asciidoc-ish
9 matches
Mail list logo
