From eea8897501abffe5a6759a388b9241d4ca70a4c3 Mon Sep 17 00:00:00 2001
From: Dave Davenport <qball@gmpclient.org>
Date: Mon, 12 Oct 2020 21:39:36 +0200
Subject: Fix some of the documentation

---
 doc/rofi.doxy.in              | 15 ---------------
 include/css-colors.h          |  2 +-
 include/dialogs/combi.h       |  2 +-
 include/dialogs/dmenu.h       |  2 +-
 include/dialogs/drun.h        |  2 +-
 include/dialogs/filebrowser.h |  2 +-
 include/dialogs/help-keys.h   |  2 +-
 include/dialogs/run.h         |  2 +-
 include/dialogs/script.h      |  2 +-
 include/dialogs/ssh.h         |  2 +-
 include/dialogs/window.h      |  2 +-
 include/helper-theme.h        |  2 +-
 include/helper.h              | 16 ++++++++++------
 include/history.h             |  2 +-
 include/keyb.h                |  2 +-
 include/mode.h                |  2 +-
 include/rofi-icon-fetcher.h   |  2 +-
 include/rofi.h                |  2 +-
 include/timings.h             |  2 +-
 include/view.h                |  2 +-
 include/widgets/box.h         |  2 +-
 include/widgets/container.h   |  2 +-
 include/widgets/icon.h        |  2 +-
 include/widgets/listview.h    |  2 +-
 include/widgets/scrollbar.h   |  2 +-
 include/widgets/textbox.h     |  2 +-
 include/widgets/widget.h      |  2 +-
 include/xrmoptions.h          |  2 +-
 source/dialogs/filebrowser.c  |  2 +-
 source/dialogs/run.c          |  2 +-
 source/dialogs/ssh.c          |  2 +-
 source/mode.c                 |  2 +-
 32 files changed, 40 insertions(+), 51 deletions(-)

diff --git a/doc/rofi.doxy.in b/doc/rofi.doxy.in
index 23654590..858c5f0e 100644
--- a/doc/rofi.doxy.in
+++ b/doc/rofi.doxy.in
@@ -2010,12 +2010,6 @@ EXTERNAL_GROUPS        = YES
 
 EXTERNAL_PAGES         = YES
 
-# The PERL_PATH should be the absolute path and name of the perl script
-# interpreter (i.e. the result of 'which perl').
-# The default file (with absolute path) is: /usr/bin/perl.
-
-PERL_PATH              = /usr/bin/perl
-
 #---------------------------------------------------------------------------
 # Configuration options related to the dot tool
 #---------------------------------------------------------------------------
@@ -2029,15 +2023,6 @@ PERL_PATH              = /usr/bin/perl
 
 CLASS_DIAGRAMS         = YES
 
-# You can define message sequence charts within doxygen comments using the \msc
-# command. Doxygen will then run the mscgen tool (see:
-# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
-# documentation. The MSCGEN_PATH tag allows you to specify the directory where
-# the mscgen tool resides. If left empty the tool is assumed to be found in the
-# default search path.
-
-MSCGEN_PATH            =
-
 # You can include diagrams made with dia in doxygen documentation. Doxygen will
 # then run dia to produce the diagram and insert it in the documentation. The
 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
diff --git a/include/css-colors.h b/include/css-colors.h
index d57fbb4a..e442c6aa 100644
--- a/include/css-colors.h
+++ b/include/css-colors.h
@@ -29,5 +29,5 @@ extern const CSSColor CSSColors[];
  * Number of named colors.
  */
 extern const unsigned int num_CSSColors;
-/* @} */
+/** @} */
 #endif // ROFI_INCLUDE_CSS_COLORS_H
diff --git a/include/dialogs/combi.h b/include/dialogs/combi.h
index 3c9660ca..9b583f75 100644
--- a/include/dialogs/combi.h
+++ b/include/dialogs/combi.h
@@ -46,5 +46,5 @@
 /** #Mode object representing the combi dialog. */
 extern Mode combi_mode;
 
-/*@}*/
+/**@}*/
 #endif // ROFI_DIALOG_COMBI_H
diff --git a/include/dialogs/dmenu.h b/include/dialogs/dmenu.h
index 6c2fa05d..577070d9 100644
--- a/include/dialogs/dmenu.h
+++ b/include/dialogs/dmenu.h
@@ -47,5 +47,5 @@ int dmenu_switcher_dialog ( void );
  */
 void print_dmenu_options ( void );
 
-/*@}*/
+/**@}*/
 #endif // ROFI_DIALOG_DMENU_H
diff --git a/include/dialogs/drun.h b/include/dialogs/drun.h
index 2b58b4c5..be6e0afa 100644
--- a/include/dialogs/drun.h
+++ b/include/dialogs/drun.h
@@ -38,5 +38,5 @@
 /** #Mode object representing the desktop menu run dialog. */
 extern Mode drun_mode;
 #endif // ENABLE_DRUN
-/*@}*/
+/**@}*/
 #endif // ROFI_DIALOG_DRUN_H
diff --git a/include/dialogs/filebrowser.h b/include/dialogs/filebrowser.h
index f57bd4a7..3609501a 100644
--- a/include/dialogs/filebrowser.h
+++ b/include/dialogs/filebrowser.h
@@ -40,5 +40,5 @@ extern Mode file_browser_mode;
 
 Mode *create_new_file_browser (void);
 ModeMode file_browser_mode_completer ( Mode *sw, int mretv, char **input, unsigned int selected_line, char **path );
-/*@}*/
+/**@}*/
 #endif // ROFI_DIALOG_FILE_BROWSER_H
diff --git a/include/dialogs/help-keys.h b/include/dialogs/help-keys.h
index c06ed5c2..062a4278 100644
--- a/include/dialogs/help-keys.h
+++ b/include/dialogs/help-keys.h
@@ -40,5 +40,5 @@
  * #Mode object representing the help key mode view
  */
 extern Mode help_keys_mode;
-/*@}*/
+/**@}*/
 #endif // ROFI_DIALOG_HELPKEYS_H
diff --git a/include/dialogs/run.h b/include/dialogs/run.h
index 36e3b365..bec0d39a 100644
--- a/include/dialogs/run.h
+++ b/include/dialogs/run.h
@@ -42,5 +42,5 @@
 /** #Mode object representing the run dialog. */
 extern Mode run_mode;
 
-/*@}*/
+/**@}*/
 #endif // DIALOG_RUN_H
diff --git a/include/dialogs/script.h b/include/dialogs/script.h
index 5695b640..c1d1b8d4 100644
--- a/include/dialogs/script.h
+++ b/include/dialogs/script.h
@@ -52,5 +52,5 @@ Mode *script_switcher_parse_setup ( const char *str );
  * @returns true when valid.
  */
 gboolean script_switcher_is_valid ( const char *token );
-/*@}*/
+/**@}*/
 #endif // ROFI_DIALOG_SCRIPT_H
diff --git a/include/dialogs/ssh.h b/include/dialogs/ssh.h
index 9022da10..9f72797a 100644
--- a/include/dialogs/ssh.h
+++ b/include/dialogs/ssh.h
@@ -46,5 +46,5 @@
 
 /** #Mode object representing the ssh dialog. */
 extern Mode ssh_mode;
-/*@}*/
+/**@}*/
 #endif // ROFI_DIALOG_SSH_H
diff --git a/include/dialogs/window.h b/include/dialogs/window.h
index 625fe3ff..4f0e0526 100644
--- a/include/dialogs/window.h
+++ b/include/dialogs/window.h
@@ -40,5 +40,5 @@
 extern Mode window_mode;
 extern Mode window_mode_cd;
 #endif // WINDOW_MODE
-/* @}*/
+/** @}*/
 #endif // ROFI_DIALOG_WINDOW_H
diff --git a/include/helper-theme.h b/include/helper-theme.h
index 008265cd..9ca4718e 100644
--- a/include/helper-theme.h
+++ b/include/helper-theme.h
@@ -52,5 +52,5 @@ PangoAttrList *helper_token_match_get_pango_attr ( RofiHighlightColorStyle th, r
  * @returns true if font is valid.
  */
 gboolean helper_validate_font ( PangoFontDescription *pfd, const char *font );
-/* @} */
+/** @} */
 #endif // ROFI_HELPER_THEME_H
diff --git a/include/helper.h b/include/helper.h
index 9554c712..8c26265a 100644
--- a/include/helper.h
+++ b/include/helper.h
@@ -228,7 +228,7 @@ char * rofi_latin_to_utf8_strdup ( const char *input, gssize length );
 /**
  * @param text the string to escape
  *
- * Escape XML markup from the string. @param text is freed.
+ * Escape XML markup from the string. text is freed.
  *
  * @return the escaped string
  */
@@ -301,7 +301,7 @@ gboolean helper_execute ( const char *wd, char **args, const char *error_precmd,
  * @param context The startup notification context, if any
  *
  * Execute command.
- * If needed members of @param context are NULL, they will be filled.
+ * If needed members of context are NULL, they will be filled.
  *
  * @returns FALSE On failure, TRUE on success
  */
@@ -330,10 +330,12 @@ cairo_surface_t *cairo_image_surface_create_from_svg ( const gchar* file, int he
 void parse_ranges ( char *input, rofi_range_pair **list, unsigned int *length );
 
 /**
- * @param format
- * @param string
- * @param selected_line
- * @param filter
+ * @param format The format string
+ * @param string The string
+ * @param selected_line selected line
+ * @param filter filter stringr
+ *
+ * Output formatted line
  */
 void rofi_output_formatted_line ( const char *format, const char *string, int selected_line, const char *filter );
 
@@ -352,4 +354,6 @@ void rofi_output_formatted_line ( const char *format, const char *string, int se
  */
 char *helper_string_replace_if_exists ( char * string, ... );
 G_END_DECLS
+
+/**@} */
 #endif // ROFI_HELPER_H
diff --git a/include/history.h b/include/history.h
index 946e9007..fe54ca76 100644
--- a/include/history.h
+++ b/include/history.h
@@ -67,5 +67,5 @@ void history_remove ( const char *filename, const char *entry ) __attribute__( (
  */
 char ** history_get_list ( const char *filename, unsigned int * length ) __attribute__( ( nonnull ) );
 
-/*@}*/
+/**@}*/
 #endif // ROFI_HISTORY_H
diff --git a/include/keyb.h b/include/keyb.h
index 911bdbc2..1f5259ea 100644
--- a/include/keyb.h
+++ b/include/keyb.h
@@ -184,5 +184,5 @@ gboolean parse_keys_abe ( NkBindings *bindings );
  */
 void setup_abe ( void );
 
-/*@}*/
+/**@}*/
 #endif // ROFI_KEYB_H
diff --git a/include/mode.h b/include/mode.h
index 5969ef8e..76aff22e 100644
--- a/include/mode.h
+++ b/include/mode.h
@@ -237,6 +237,6 @@ char * mode_preprocess_input ( Mode *mode, const char *input );
  * @return a new allocated (valid pango markup) message to display (user should free).
  */
 char *mode_get_message ( const Mode *mode );
-/*@}*/
+/**@}*/
 G_END_DECLS
 #endif
diff --git a/include/rofi-icon-fetcher.h b/include/rofi-icon-fetcher.h
index ba7c79c7..25db41df 100644
--- a/include/rofi-icon-fetcher.h
+++ b/include/rofi-icon-fetcher.h
@@ -45,5 +45,5 @@ uint32_t rofi_icon_fetcher_query ( const char *name, const int size );
  */
 cairo_surface_t * rofi_icon_fetcher_get ( const uint32_t uid );
 
-/* @} */
+/** @} */
 #endif // ROFI_ICON_FETCHER_H
diff --git a/include/rofi.h b/include/rofi.h
index 11563b30..1a0f43f4 100644
--- a/include/rofi.h
+++ b/include/rofi.h
@@ -108,5 +108,5 @@ Mode * rofi_collect_modi_search ( const char *name );
     " <i>https://github.com/davatorium/rofi/</i>"
 /** Indicates if ERROR_MSG uses pango markup */
 #define ERROR_MSG_MARKUP    TRUE
-/*@}*/
+/**@}*/
 #endif
diff --git a/include/timings.h b/include/timings.h
index 26218689..ea27f202 100644
--- a/include/timings.h
+++ b/include/timings.h
@@ -94,4 +94,4 @@ void rofi_timings_quit ( void );
 #define TICK_N( a )
 
 #endif // ROFI_TIMINGS_H
-/*@}*/
+/**@}*/
diff --git a/include/view.h b/include/view.h
index a91d0e3d..fadb8a68 100644
--- a/include/view.h
+++ b/include/view.h
@@ -322,5 +322,5 @@ void rofi_view_set_window_title ( const char * title  );
  * set ellipsize mode to start.
  */
 void rofi_view_ellipsize_start ( RofiViewState *state );
-/**@}*/
+/** @}*/
 #endif
diff --git a/include/widgets/box.h b/include/widgets/box.h
index ac602321..18c68788 100644
--- a/include/widgets/box.h
+++ b/include/widgets/box.h
@@ -64,5 +64,5 @@ box * box_create ( widget *parent, const char *name, RofiOrientation type );
  * Add a widget to the box.
  */
 void box_add ( box *box, widget *child, gboolean expand );
-/*@}*/
+/**@}*/
 #endif // ROFI_HBOX_H
diff --git a/include/widgets/container.h b/include/widgets/container.h
index b3ff2862..98e8cff4 100644
--- a/include/widgets/container.h
+++ b/include/widgets/container.h
@@ -58,5 +58,5 @@ container * container_create ( widget *parent, const char *name );
  * Add a widget to the container.
  */
 void container_add ( container *container, widget *child );
-/*@}*/
+/**@}*/
 #endif // ROFI_CONTAINER_H
diff --git a/include/widgets/icon.h b/include/widgets/icon.h
index 315eda8a..99793c8c 100644
--- a/include/widgets/icon.h
+++ b/include/widgets/icon.h
@@ -63,5 +63,5 @@ void icon_set_size ( widget *icon, const int size );
  * @param surf The surface to display.
  */
 void icon_set_surface ( icon *icon, cairo_surface_t *surf );
-/*@}*/
+/**@}*/
 #endif // ROFI_ICON_H
diff --git a/include/widgets/listview.h b/include/widgets/listview.h
index 90c31bba..f9d2510c 100644
--- a/include/widgets/listview.h
+++ b/include/widgets/listview.h
@@ -252,6 +252,6 @@ void listview_toggle_ellipsizing ( listview *lv );
  */
 
 void listview_set_ellipsize_start ( listview *lv );
-/* @} */
+/** @} */
 
 #endif // ROFI_LISTVIEW_H
diff --git a/include/widgets/scrollbar.h b/include/widgets/scrollbar.h
index f7b45a34..b9bb9915 100644
--- a/include/widgets/scrollbar.h
+++ b/include/widgets/scrollbar.h
@@ -91,5 +91,5 @@ void scrollbar_set_max_value ( scrollbar *sb, unsigned int max );
  */
 guint scrollbar_scroll_get_line ( const scrollbar *sb, int y );
 
-/*@}*/
+/**@}*/
 #endif // ROFI_SCROLLBAR_H
diff --git a/include/widgets/textbox.h b/include/widgets/textbox.h
index cb9be121..965f1f14 100644
--- a/include/widgets/textbox.h
+++ b/include/widgets/textbox.h
@@ -336,5 +336,5 @@ void textbox_cursor_end ( textbox *tb );
  * Set the ellipsizing mode used on the string.
  */
 void textbox_set_ellipsize ( textbox *tb, PangoEllipsizeMode mode );
-/*@}*/
+/**@}*/
 #endif //ROFI_TEXTBOX_H
diff --git a/include/widgets/widget.h b/include/widgets/widget.h
index 28fa2c0d..3c8724b1 100644
--- a/include/widgets/widget.h
+++ b/include/widgets/widget.h
@@ -348,5 +348,5 @@ int widget_get_absolute_xpos ( widget *wid );
  */
 int widget_get_absolute_ypos ( widget *wid );
 
-/*@}*/
+/**@}*/
 #endif // ROFI_WIDGET_H
diff --git a/include/xrmoptions.h b/include/xrmoptions.h
index ed5c0141..573ad810 100644
--- a/include/xrmoptions.h
+++ b/include/xrmoptions.h
@@ -173,5 +173,5 @@ gboolean config_parse_set_property ( const Property *p, char **error );
  * @brief Dump configuration in rasi format.
  */
 void config_parse_dump_config_rasi_format ( FILE *out, gboolean changes );
-/* @}*/
+/** @}*/
 #endif
diff --git a/source/dialogs/filebrowser.c b/source/dialogs/filebrowser.c
index 90f1b133..9e04f521 100644
--- a/source/dialogs/filebrowser.c
+++ b/source/dialogs/filebrowser.c
@@ -269,7 +269,7 @@ static char *_get_display_value ( const Mode *sw, unsigned int selected_line, G_
  *
  * Match the entry.
  *
- * @param returns try when a match.
+ * @returns try when a match.
  */
 static int file_browser_token_match ( const Mode *sw, rofi_int_matcher **tokens, unsigned int index )
 {
diff --git a/source/dialogs/run.c b/source/dialogs/run.c
index 5e0c064a..71800213 100644
--- a/source/dialogs/run.c
+++ b/source/dialogs/run.c
@@ -424,4 +424,4 @@ Mode run_mode =
     .private_data       = NULL,
     .free               = NULL
 };
-/*@}*/
+/** @}*/
diff --git a/source/dialogs/ssh.c b/source/dialogs/ssh.c
index fd590551..51e19a7c 100644
--- a/source/dialogs/ssh.c
+++ b/source/dialogs/ssh.c
@@ -658,4 +658,4 @@ Mode ssh_mode =
     .private_data       = NULL,
     .free               = NULL
 };
-/*@}*/
+/**@}*/
diff --git a/source/mode.c b/source/mode.c
index 6b7b2f48..1f0189b0 100644
--- a/source/mode.c
+++ b/source/mode.c
@@ -179,4 +179,4 @@ char *mode_get_message ( const Mode *mode )
     }
     return NULL;
 }
-/*@}*/
+/**@}*/
-- 
cgit v1.2.3