summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Davenport <qball@blame.services>2022-07-28 00:23:21 +0200
committerDave Davenport <qball@blame.services>2022-07-28 00:23:21 +0200
commit2efd6a98a58fd8b32b802a675a52cb8383f2d0ea (patch)
tree38bf8a96ca7281afbba9ccd04ed8045eea332fc1
parentfb24fc09992404352a998c02b9fdf24ee54d3af5 (diff)
[Doxy] Fix the doxygen check and some warnings.
-rw-r--r--.github/actions/doxycheck/action.yml2
-rw-r--r--.github/actions/meson/action.yml2
-rw-r--r--doc/rofi.doxy.in6
-rw-r--r--include/mode-private.h5
-rw-r--r--include/widgets/listview.h1
-rw-r--r--include/widgets/widget.h8
6 files changed, 12 insertions, 12 deletions
diff --git a/.github/actions/doxycheck/action.yml b/.github/actions/doxycheck/action.yml
index e362ebe0..63a4c649 100644
--- a/.github/actions/doxycheck/action.yml
+++ b/.github/actions/doxycheck/action.yml
@@ -11,7 +11,7 @@ runs:
steps:
- id: check
run: |
- if [[ "$(grep -c warning ${{ inputs.logfile }})" != 0 ]]; then
+ if [[ "$(grep -c warning: ${{ inputs.logfile }})" != 0 ]]; then
echo
echo Doxygen warnings found:
grep warning ${{ inputs.logfile }}
diff --git a/.github/actions/meson/action.yml b/.github/actions/meson/action.yml
index cd2143d9..39cb674f 100644
--- a/.github/actions/meson/action.yml
+++ b/.github/actions/meson/action.yml
@@ -27,7 +27,7 @@ runs:
run: ninja -C builddir test
shell: bash
- id: doxy
- run: ninja -C builddir doc/html 2>&1 > doxygen.log
+ run: ninja -C builddir doc/html > doxygen.log 2>&1
shell: bash
- id: doxycheck
uses: ./.github/actions/doxycheck
diff --git a/doc/rofi.doxy.in b/doc/rofi.doxy.in
index 858c5f0e..b3ffb8ec 100644
--- a/doc/rofi.doxy.in
+++ b/doc/rofi.doxy.in
@@ -236,7 +236,7 @@ ALIASES =
# A mapping has the form "name=value". For example adding "class=itcl::class"
# will allow you to use the command class in the itcl::class meaning.
-TCL_SUBST =
+# TCL_SUBST =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
@@ -995,7 +995,7 @@ ALPHABETICAL_INDEX = NO
# Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
-COLS_IN_ALPHA_INDEX = 5
+#COLS_IN_ALPHA_INDEX = 5
# In case all classes in a project start with a common prefix, all classes will
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
@@ -1599,7 +1599,7 @@ COMPACT_LATEX = NO
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
-PAPER_TYPE = a4wide
+#PAPER_TYPE = a4wide
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. To get the times font for
diff --git a/include/mode-private.h b/include/mode-private.h
index 8becbdab..a64cc6fd 100644
--- a/include/mode-private.h
+++ b/include/mode-private.h
@@ -60,6 +60,7 @@ typedef char *(*_mode_get_display_value)(const Mode *sw,
/**
* @param sw The #Mode pointer
* @param selected_line The selected line
+ * @param height The height of the icon
*
* Obtains the icon if available
*
@@ -81,11 +82,9 @@ typedef char *(*_mode_get_completion)(const Mode *sw,
unsigned int selected_line);
/**
+ * @param data The #Mode pointer
* @param tokens List of (input) tokens to match.
- * @param input The entry to match against.
- * @param case_sensitive Whether case is significant.
* @param index The current selected index.
- * @param data User data.
*
* Function prototype for the matching algorithm.
*
diff --git a/include/widgets/listview.h b/include/widgets/listview.h
index 07e76929..ad44f15c 100644
--- a/include/widgets/listview.h
+++ b/include/widgets/listview.h
@@ -55,6 +55,7 @@ typedef enum {
/**
* @param tb The textbox to set
+ * @param ico The icon to set
* @param entry The position of the textbox
* @param udata User data
* @param type The textbox font style to apply to this entry (normal, selected,
diff --git a/include/widgets/widget.h b/include/widgets/widget.h
index c2897c9b..f41437b1 100644
--- a/include/widgets/widget.h
+++ b/include/widgets/widget.h
@@ -87,8 +87,8 @@ typedef enum {
/**
* @param widget The container widget itself
* @param type The widget type searched for
- * @param x The X coordination of the mouse event relative to @param widget
- * @param y The Y coordination of the mouse event relative to @param widget
+ * @param x The X coordination of the mouse event relative to #widget
+ * @param y The Y coordination of the mouse event relative to #widget
*
* This callback must only iterate over the children of a Widget, and return
* NULL if none of them is relevant.
@@ -101,8 +101,8 @@ typedef widget *(*widget_find_mouse_target_cb)(widget *widget, WidgetType type,
/**
* @param widget The target widget
* @param action The action value (which enum it is depends on the widget type)
- * @param x The X coordination of the mouse event relative to @param widget
- * @param y The Y coordination of the mouse event relative to @param widget
+ * @param x The X coordination of the mouse event relative to #widget
+ * @param y The Y coordination of the mouse event relative to #widget
* @param user_data The data passed to widget_set_trigger_action_handler()
*
* This callback should handle the action if relevant, and returns whether it