1
0
Fork 0
mirror of https://github.com/davatorium/rofi.git synced 2024-11-18 13:54:36 -05:00

[Doxy] Fix the doxygen check and some warnings.

This commit is contained in:
Dave Davenport 2022-07-28 00:23:21 +02:00
parent fb24fc0999
commit 2efd6a98a5
6 changed files with 12 additions and 12 deletions

View file

@ -11,7 +11,7 @@ runs:
steps: steps:
- id: check - id: check
run: | run: |
if [[ "$(grep -c warning ${{ inputs.logfile }})" != 0 ]]; then if [[ "$(grep -c warning: ${{ inputs.logfile }})" != 0 ]]; then
echo echo
echo Doxygen warnings found: echo Doxygen warnings found:
grep warning ${{ inputs.logfile }} grep warning ${{ inputs.logfile }}

View file

@ -27,7 +27,7 @@ runs:
run: ninja -C builddir test run: ninja -C builddir test
shell: bash shell: bash
- id: doxy - id: doxy
run: ninja -C builddir doc/html 2>&1 > doxygen.log run: ninja -C builddir doc/html > doxygen.log 2>&1
shell: bash shell: bash
- id: doxycheck - id: doxycheck
uses: ./.github/actions/doxycheck uses: ./.github/actions/doxycheck

View file

@ -236,7 +236,7 @@ ALIASES =
# A mapping has the form "name=value". For example adding "class=itcl::class" # 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. # 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 # 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 # 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. # Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. # 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 # 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 # 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. # The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES. # 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 # 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 # that should be included in the LaTeX output. To get the times font for

View file

@ -60,6 +60,7 @@ typedef char *(*_mode_get_display_value)(const Mode *sw,
/** /**
* @param sw The #Mode pointer * @param sw The #Mode pointer
* @param selected_line The selected line * @param selected_line The selected line
* @param height The height of the icon
* *
* Obtains the icon if available * Obtains the icon if available
* *
@ -81,11 +82,9 @@ typedef char *(*_mode_get_completion)(const Mode *sw,
unsigned int selected_line); unsigned int selected_line);
/** /**
* @param data The #Mode pointer
* @param tokens List of (input) tokens to match. * @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 index The current selected index.
* @param data User data.
* *
* Function prototype for the matching algorithm. * Function prototype for the matching algorithm.
* *

View file

@ -55,6 +55,7 @@ typedef enum {
/** /**
* @param tb The textbox to set * @param tb The textbox to set
* @param ico The icon to set
* @param entry The position of the textbox * @param entry The position of the textbox
* @param udata User data * @param udata User data
* @param type The textbox font style to apply to this entry (normal, selected, * @param type The textbox font style to apply to this entry (normal, selected,

View file

@ -87,8 +87,8 @@ typedef enum {
/** /**
* @param widget The container widget itself * @param widget The container widget itself
* @param type The widget type searched for * @param type The widget type searched for
* @param x The X 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 @param 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 * This callback must only iterate over the children of a Widget, and return
* NULL if none of them is relevant. * 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 widget The target widget
* @param action The action value (which enum it is depends on the widget type) * @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 x The X coordination of the mouse event relative to #widget
* @param y The Y coordination of the mouse event relative to @param 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() * @param user_data The data passed to widget_set_trigger_action_handler()
* *
* This callback should handle the action if relevant, and returns whether it * This callback should handle the action if relevant, and returns whether it