Re: [PATCH 1/4] strbuf: migrate api-strbuf.txt documentation to strbuf.h

2014-12-12 Thread Jonathan Nieder
Jeff King wrote: > Signed-off-by: Jeff King > --- > Documentation/technical/api-strbuf.txt | 351 - > strbuf.h | 458 > - > 2 files changed, 390 insertions(+), 419 deletions(-) > delete mode 100644 Documentat

Re: [PATCH 1/4] strbuf: migrate api-strbuf.txt documentation to strbuf.h

2014-12-12 Thread Junio C Hamano
Jeff King writes: > +/** > + * * Related to the contents of the buffer > + */ > + > +/** > + * Strip whitespace from the beginning and end of a string. > + * Equivalent to performing `strbuf_rtrim()` followed by `strbuf_ltrim()`. > + */ > extern void strbuf_trim(struct strbuf *); > + > +/** > +

Re: [PATCH 1/4] strbuf: migrate api-strbuf.txt documentation to strbuf.h

2014-12-12 Thread Jeff King
On Fri, Dec 12, 2014 at 04:28:00PM -0500, Jeff King wrote: > 1. All comments created in this way are started with "/**" > to indicate they are part of the API documentation. This > may help later with extracting the text to pretty-print > it. By the way, two thoughts I had while work

[PATCH 1/4] strbuf: migrate api-strbuf.txt documentation to strbuf.h

2014-12-12 Thread Jeff King
Some of strbuf is documented as comments above functions, and some is separate in Documentation/technical/api-strbuf.txt. This makes it annoying to find the appropriate documentation. We'd rather have it all in one place, which means all in the text document, or all in the header. Let's choose the