On Wed, 1 Dec 2021 at 22:40, Frank H. Ellenberger
<frank.h.ellenber...@gmail.com> wrote:
>
> Hi Kevin,
>
> don't forget to CC the list.
>
> Am 01.12.21 um 03:22 schrieb Kevin Buckley:
> > On Sat, 27 Nov 2021 at 23:36, Frank H. Ellenberger
> > <frank.h.ellenber...@gmail.com> wrote:
> >>
> >> 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
> >
> > Yes the "a the" is visible there too.
> >
> > If I navigate through to, say,
> >
> > https://code.gnucash.org/docs/MAINT/group__Import__Export.html#gad26d36e9e962bb4ba174d697f59f25fb
> >
> > which is the doc for this fucntion
> >
> > gnc_gen_trans_list_empty()
> >
> > I see
> >
> > gboolean gnc_gen_trans_list_empty ( GNCImportMainMatcher * info)
> >
> > Checks whether there are no transactions to match.
> >
> > Parameters
> > info A pointer to a the GNCImportMainMatcher structure.
> >
> > so the "a the" is in there too.
> >
> > FWIW, I have noticed a few other typos and spelling corrections in
> > the comments, so maybe I should clone the repo and submit a PR
> > with them all in?
>
> Yes, that would be the best approach.
> See also https://wiki.gnucash.org/wiki/Doxygen
>
> Regards
> Frank
Find a patch from a `git diff -p -stat` attached.
gnucash/gnome-utils/gnc-main-window.h | 6 +++---
gnucash/gnome-utils/gnc-tree-view-commodity.h | 2 +-
gnucash/import-export/import-main-matcher.h | 16 ++++++++--------
gnucash/register/register-gnome/gnucash-sheet.c | 2 +-
libgnucash/app-utils/calculation/expression_parser.c | 2 +-
libgnucash/app-utils/gnc-sx-instance-model.c | 2 +-
libgnucash/engine/qofid.h | 2 +-
7 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/gnucash/gnome-utils/gnc-main-window.h b/gnucash/gnome-utils/gnc-main-window.h
index 35b70d588..305494e73 100644
--- a/gnucash/gnome-utils/gnc-main-window.h
+++ b/gnucash/gnome-utils/gnc-main-window.h
@@ -361,7 +361,7 @@ void gnc_main_window_restore_all_windows(const GKeyFile *keyfile);
* used on report pages to delay the creation of the report till the
* page is focused.
*
- * @param window When window whose pages should be checked.
+ * @param window The window whose pages should be checked.
*
* @return TRUE if pages are being restored
*/
@@ -383,7 +383,7 @@ void gnc_main_window_restore_default_state(GncMainWindow *window);
* If any page returns a failure indication, then the function stops
* walking pages and immediately returns a failure.
*
- * @param window When window whose pages should be checked.
+ * @param window The window whose pages should be checked.
*
* @return FALSE if any page could not or would not comply, which
* should cancel the pending operation. TRUE otherwise */
@@ -412,7 +412,7 @@ void gnc_main_window_all_action_set_sensitive (const gchar *action_name, gboolea
/** Find action in main window.
*
- * @param window When window which should be checked for the action.
+ * @param window The window which should be checked for the action.
*
* @param name The name of the command to be retrieved.
*
diff --git a/gnucash/gnome-utils/gnc-tree-view-commodity.h b/gnucash/gnome-utils/gnc-tree-view-commodity.h
index eeacdeb7b..1f7e80bb5 100644
--- a/gnucash/gnome-utils/gnc-tree-view-commodity.h
+++ b/gnucash/gnome-utils/gnc-tree-view-commodity.h
@@ -208,7 +208,7 @@ gnc_commodity * gnc_tree_view_commodity_get_selected_commodity (GncTreeViewComm
*
* @param view A pointer to an commodity tree view.
*
- * @param The commodity to select.
+ * @param commodity The commodity to select.
*/
void gnc_tree_view_commodity_select_commodity (GncTreeViewCommodity *view, gnc_commodity *commodity);
diff --git a/gnucash/import-export/import-main-matcher.h b/gnucash/import-export/import-main-matcher.h
index 490d54c44..51ddf4f53 100644
--- a/gnucash/import-export/import-main-matcher.h
+++ b/gnucash/import-export/import-main-matcher.h
@@ -112,7 +112,7 @@ GNCImportMainMatcher * gnc_gen_trans_assist_new (GtkWidget *parent,
/** This starts the import process for transaction from an assistant.
* assistant button callback.
*
- * @param info. A pointer to a the GNCImportMainMatcher structure.
+ * @param info. A pointer to the GNCImportMainMatcher structure
*/
void gnc_gen_trans_assist_start (GNCImportMainMatcher *info);
@@ -177,38 +177,38 @@ void gnc_gen_trans_list_add_trans_with_ref_id (GNCImportMainMatcher *gui,
/** Run this dialog and return only after the user pressed Ok, Cancel,
or closed the window. This means that all actual importing will
have been finished upon returning.
- * @param info A pointer to a the GNCImportMainMatcher structure.
+ * @param info A pointer to the GNCImportMainMatcher structure.
* @return The boolean return value of the dialog run.
*/
gboolean gnc_gen_trans_list_run (GNCImportMainMatcher *info);
/** Returns the widget of this dialog.
- * @param info A pointer to a the GNCImportMainMatcher structure.
+ * @param info A pointer to the GNCImportMainMatcher structure.
* @return A GtkWidget pointer to the dialog's widget.
*/
GtkWidget *gnc_gen_trans_list_widget (GNCImportMainMatcher *info);
/** Returns the append_text widget of this dialog.
- * @param info A pointer to a the GNCImportMainMatcher structure.
+ * @param info A pointer to the GNCImportMainMatcher structure.
* @return A GtkWidget pointer to the append_text widget.
*/
GtkWidget *
gnc_gen_trans_list_append_text_widget (GNCImportMainMatcher *info);
/** Checks whether there are no transactions to match.
- * @param info A pointer to a the GNCImportMainMatcher structure.
+ * @param info A pointer to the GNCImportMainMatcher structure.
* @return A boolean indicating whether the transaction list is empty.
*/
gboolean gnc_gen_trans_list_empty (GNCImportMainMatcher *info);
/** Shows widgets.
- * @param info A pointer to a the GNCImportMainMatcher structure.
+ * @param info A pointer to the GNCImportMainMatcher structure.
*/
void gnc_gen_trans_list_show_all (GNCImportMainMatcher *info);
/** Show and set the reconcile after close check button.
- * @param info A pointer to a the GNCImportMainMatcher structure.
+ * @param info A pointer to the GNCImportMainMatcher structure.
* @param reconcile_after_close A gboolean that shows or hides the button.
* @param active A gboolean to set or clear the check button.
*/
@@ -216,7 +216,7 @@ void gnc_gen_trans_list_show_reconcile_after_close_button (GNCImportMainMatcher
gboolean reconcile_after_close,
gboolean active);
/** Returns the reconcile after close check button.
- * @param info A pointer to a the GNCImportMainMatcher structure.
+ * @param info A pointer to the GNCImportMainMatcher structure.
* @return The check button.
*/
GtkWidget* gnc_gen_trans_list_get_reconcile_after_close_button (GNCImportMainMatcher *info);
diff --git a/gnucash/register/register-gnome/gnucash-sheet.c b/gnucash/register/register-gnome/gnucash-sheet.c
index 54d32ba61..03581106b 100644
--- a/gnucash/register/register-gnome/gnucash-sheet.c
+++ b/gnucash/register/register-gnome/gnucash-sheet.c
@@ -1530,7 +1530,7 @@ gnucash_sheet_button_press_event (GtkWidget *widget, GdkEventButton *event)
gnucash_sheet_cursor_move (sheet, new_virt_loc);
- // if clicked in ocument link cell, run call back
+ // if clicked in document link cell, run call back
if (g_strcmp0 (gnc_table_get_cell_name (table, new_virt_loc), DOCLINK_CELL) == 0)
{
if (sheet->open_doclink_cb)
diff --git a/libgnucash/app-utils/calculation/expression_parser.c b/libgnucash/app-utils/calculation/expression_parser.c
index 9159deaaa..3115217c7 100644
--- a/libgnucash/app-utils/calculation/expression_parser.c
+++ b/libgnucash/app-utils/calculation/expression_parser.c
@@ -297,7 +297,7 @@
* to the parser. The calling function(s) should never rely on
* manipulating any information inside this structure
* directly, since it may and could change in the future. --
- * The first parameter is a pointer to a the first element in
+ * The first parameter is a pointer to the first element in
* a linked list of "pre-defined" variables the caller wishes
* to use with subsequent calls to the parser. -- The second
* parameter is the radix character to use in numeric strings
diff --git a/libgnucash/app-utils/gnc-sx-instance-model.c b/libgnucash/app-utils/gnc-sx-instance-model.c
index 717a371f8..924c20b60 100644
--- a/libgnucash/app-utils/gnc-sx-instance-model.c
+++ b/libgnucash/app-utils/gnc-sx-instance-model.c
@@ -1049,7 +1049,7 @@ _get_sx_formula_value(const SchedXaction* sx,
!gnc_numeric_zero_p(*numeric_val))
{
/* If there are no variables to parse and we had a valid numeric stored
- * then we can skip parsing the formual, which might save some
+ * then we can skip parsing the formula, which might save some
* localization problems with separators. */
numeric->num = numeric_val->num;
numeric->denom = numeric_val->denom;
diff --git a/libgnucash/engine/qofid.h b/libgnucash/engine/qofid.h
index 1e84d1395..6c1caac85 100644
--- a/libgnucash/engine/qofid.h
+++ b/libgnucash/engine/qofid.h
@@ -43,7 +43,7 @@ extern "C"
type, each uniquely identified by a given ID. QOF Entities
can be used independently of any other part of the system.
In particular, Entities can be useful even if one is not using
- the Query one Object parts of the QOF system.
+ the Query and Object parts of the QOF system.
Identifiers are globally-unique and permanent, i.e., once
an entity has been assigned an identifier, it retains that same
_______________________________________________
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel
