[GNC-dev] Small changes to comment text, mostly in gnucash/import-export/import-main-matcher.h

[Frank H. Ellenberger]

Hi Kevin,

The comments containing "@param" are doxygen sources. How looks the reesult
https://code.gnucash.org/docs/MAINT/import-main-matcher_8h.html and links?

Regards
Frank

Am 25.11.21 um 06:58 schrieb Kevin Buckley:
> For reasons I'll not go into (?!) I happened to notice that  there
> are a few  places in the source where the text reads, eg,
> 
> * @param info. A pointer to a the  <struct_name> structure
> 
> Not clear if the "a the" was meant, but, as there are a shedload of
> "A pointer to the <something>" strings, but no "A pointer to a <something>"
> strings that I could grep, in case it helps tidy up the codebase, a recent grep
> on the maint branch returned:
> 
> ./gnucash/import-export/import-main-matcher.h: * @param info. A
> pointer to a the GNCImportMainMatcher structure.
> ./gnucash/import-export/import-main-matcher.h: * @param info A pointer
> to a the GNCImportMainMatcher structure.
> ./gnucash/import-export/import-main-matcher.h: * @param info A pointer
> to a the GNCImportMainMatcher structure.
> ./gnucash/import-export/import-main-matcher.h: * @param info A pointer
> to a the GNCImportMainMatcher structure.
> ./gnucash/import-export/import-main-matcher.h: * @param info A pointer
> to a the GNCImportMainMatcher structure.
> ./gnucash/import-export/import-main-matcher.h: * @param info A pointer
> to a the GNCImportMainMatcher structure.
> ./gnucash/import-export/import-main-matcher.h: * @param info A pointer
> to a the GNCImportMainMatcher structure.
> ./libgnucash/engine/gnc-numeric.h: *  @param a the ::gnc_numeric value
> to convert
> ./libgnucash/app-utils/calculation/expression_parser.c: *         The
> first parameter is a pointer to a the first element in
> 
> I also note that the first of those has a periof after the parameter name,
> whilst none of the others do.
> 
> HTH, and thanks, as always, for GnuCash,
> Kevin
> _______________________________________________
> gnucash-devel mailing list
> gnucash-devel at gnucash.org
> https://lists.gnucash.org/mailman/listinfo/gnucash-devel
>