another bus ride, another few comments to catch up with... On Sun, Oct 25, 2009 at 03:50:44PM -0500, Jonathan Nieder wrote: > > +/** Prompt the user for how to resolve a conffile conflict > > There are not many of these documentation comments, but adding some > seems like a good idea, especially if these functions are to > eventually be usable by other frontends.
or if other people are to join/contribute :)
> Will documentation processing tools choke on the string /*** used
> elsewhere? (Just curious.)
in my experience doxygen is pretty robust in not treating documentation
and/or formatting errors as fatal errors (there's probably a config option
to reverse the behavior though). typically it just spits something to
stderr and continues, maybe discarding/ignoring bad input.
> Some pedantic clarifications:
>
> @param pkg The name of the package
<snip>
i think guillem took care of this.
> > + * @param what Hints on what action should be taken by defualt.
>
> These contain not just hints but required information, right?
you can document a function without defining the params/return, but
doxygen will complain that the function documentation is incomplete. so,
not required but generally a good practice.
> Maybe I am being too pedantic here, since most functions don’t have
> documentation at all! So feel free to ignore. :)
yes it might be wierd to
see an arbitrary function so thoroughly documented when the rest of
the code is a bit more spartan, but... gotta start somewhere right?
On Sun, Oct 25, 2009 at 03:33:32PM -0500, Jonathan Nieder wrote:
> > diff --git a/src/configure.c b/src/configure.c
> > index 72d15de..1aa8b6a 100644
> > --- a/src/configure.c
> > +++ b/src/configure.c
<snip>
>
> There is some trailing whitespace here. If you have time, checking
> patches with the sample pre-commit hook (.git/hooks/pre-commit.sample)
> or git diff --check can be a help.
rebased / fixed on my end as well, thanks.
sean
--
signature.asc
Description: Digital signature
