diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..7aeccb89c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,71 @@ +# Welcome to FlipperZero contributing guide + +Thank you for investing your time in contributing to our project! + +Read our [Code of Coduct](CODE_OF_CONDUCT.md) to keep our community approachable and respectable. + +In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. + +## New contributor guide + +See the [ReadMe](ReadMe.md) to get an overview of the project. Here are some helpful resources to get you comfortable with open source contribution: + +- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) +- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git) +- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) +- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) + +## Getting started + +Before writing code and creating PR make sure that it aligns with our mission and guidlines: + +- All our devices are intended for research and education. +- PR that contains code intended to commit crimes is not going to be accepted. +- Your PR must contain code compatiable with project [LICENSE](LICENSE). +- PR will only be merged if it pass CI/CD. +- PR will only be merged if it pass review by code owner. + +Feel free to ask questions in issues if you're not sure. + +### Issues + +#### Create a new issue + +If you found a problem, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/flipperdevices/flipperzero-firmware/issues/new/choose). + +#### Solve an issue + +Scan through our [existing issues](https://github.com/flipperdevices/flipperzero-firmware/issues) to find one that interests you. + +### Make Changes + +1. Fork the repository. +- Using GitHub Desktop: + - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop. + - Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)! + +- Using the command line: + - [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them. + +2. Install build requirements + +3. Create a working branch and start with your changes! + +### Commit your update + +Commit the changes once you are happy with them. Make sure that code compilation is not broken and passes tests. Check syntax and formatting. + +### Pull Request + +When you're done making the changes, open a pull request, often referred to as a PR. +- Fill out the "Ready for review" template so we can review your PR. This template helps reviewers understand your changes and the purpose of your pull request. +- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one. +- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge. +Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information. +- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch. +- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). +- If you run into any merge issues, checkout this [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) to help you resolve merge conflicts and other issues. + +### Your PR is merged! + +Congratulations :tada::tada: The FlipperDevices team thanks you :sparkles:. diff --git a/ReadMe.md b/ReadMe.md index 9fd856879..073b23de9 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -162,6 +162,7 @@ Finally, you will have **`firmware/.obj/f6/full.dfu`** file that can be distribu - core - core libraries: home for furi - debug - debug helpers, plugins and tools - docker - docker image sources (used for automated firmware build) +- documentation - documentation generation system configs and input files - firmware - firmware for flipper * targets - targets' hal and implementation - lib - different libraries and drivers that apps and firmware uses diff --git a/applications/cli/cli.h b/applications/cli/cli.h index b6f524a12..9a166dc5b 100644 --- a/applications/cli/cli.h +++ b/applications/cli/cli.h @@ -1,11 +1,16 @@ +/** + * @file cli.h + * Cli API + */ + #pragma once +#include + #ifdef __cplusplus extern "C" { #endif -#include - typedef enum { CliSymbolAsciiSOH = 0x01, CliSymbolAsciiETX = 0x03, @@ -21,30 +26,29 @@ typedef enum { } CliSymbols; typedef enum { - CliCommandFlagDefault = 0, /** Default, loader lock is used */ + CliCommandFlagDefault = 0, /**< Default, loader lock is used */ CliCommandFlagParallelSafe = - (1 << 0), /** Safe to run in parallel with other apps, loader lock is not used */ - CliCommandFlagInsomniaSafe = (1 << 1), /** Safe to run with insomnia mode on */ + (1 << 0), /**< Safe to run in parallel with other apps, loader lock is not used */ + CliCommandFlagInsomniaSafe = (1 << 1), /**< Safe to run with insomnia mode on */ } CliCommandFlag; -/* Cli type - * Anonymous structure. Use cli_i.h if you need to go deeper. - */ +/** Cli type anonymous structure */ typedef struct Cli Cli; -/* Cli callback function pointer. - * Implement this interface and use add_cli_command - * @param args - string with what was passed after command - * @param context - pointer to whatever you gave us on cli_add_command +/** Cli callback function pointer. Implement this interface and use + * add_cli_command + * @param args string with what was passed after command + * @param context pointer to whatever you gave us on cli_add_command */ typedef void (*CliCallback)(Cli* cli, string_t args, void* context); -/* Add cli command - * Registers you command callback - * @param cli - pointer to cli instance - * @param name - command name - * @param callback - callback function - * @param context - pointer to whatever we need to pass to callback +/** Add cli command Registers you command callback + * + * @param cli pointer to cli instance + * @param name command name + * @param flags CliCommandFlag + * @param callback callback function + * @param context pointer to whatever we need to pass to callback */ void cli_add_command( Cli* cli, @@ -53,51 +57,56 @@ void cli_add_command( CliCallback callback, void* context); -/* Print unified cmd usage tip - * @param cmd - cmd name - * @param usage - usage tip - * @param arg - arg passed by user +/** Print unified cmd usage tip + * + * @param cmd cmd name + * @param usage usage tip + * @param arg arg passed by user */ - void cli_print_usage(const char* cmd, const char* usage, const char* arg); -/* Delete cli command - * @param cli - pointer to cli instance - * @param name - command name +/** Delete cli command + * + * @param cli pointer to cli instance + * @param name command name */ void cli_delete_command(Cli* cli, const char* name); -/* Read from terminal - * Do it only from inside of cli call. - * @param cli - Cli instance - * @param buffer - pointer to buffer - * @param size - size of buffer in bytes - * @return bytes written +/** Read from terminal Do it only from inside of cli call. + * + * @param cli Cli instance + * @param buffer pointer to buffer + * @param size size of buffer in bytes + * + * @return bytes written */ size_t cli_read(Cli* cli, uint8_t* buffer, size_t size); -/* Not blocking check for interrupt command received - * @param cli - Cli instance +/** Not blocking check for interrupt command received + * + * @param cli Cli instance + * + * @return true if received */ bool cli_cmd_interrupt_received(Cli* cli); -/* Write to terminal - * Do it only from inside of cli call. - * @param cli - Cli instance - * @param buffer - pointer to buffer - * @param size - size of buffer in bytes - * @return bytes written +/** Write to terminal Do it only from inside of cli call. + * + * @param cli Cli instance + * @param buffer pointer to buffer + * @param size size of buffer in bytes */ void cli_write(Cli* cli, const uint8_t* buffer, size_t size); -/* Read character - * @param cli - Cli instance - * @return char +/** Read character + * + * @param cli Cli instance + * + * @return char */ char cli_getc(Cli* cli); -/* New line - * Send new ine sequence +/** New line Send new ine sequence */ void cli_nl(); diff --git a/applications/gui/canvas.h b/applications/gui/canvas.h index db4bec1fc..7d7ef997e 100644 --- a/applications/gui/canvas.h +++ b/applications/gui/canvas.h @@ -1,3 +1,8 @@ +/** + * @file canvas.h + * GUI: Canvas API + */ + #pragma once #include @@ -8,13 +13,16 @@ extern "C" { #endif +/** Color enumeration */ typedef enum { ColorWhite = 0x00, ColorBlack = 0x01, } Color; +/** Fonts enumeration */ typedef enum { FontPrimary, FontSecondary, FontKeyboard } Font; +/** Alignment enumeration */ typedef enum { AlignLeft, AlignRight, @@ -23,59 +31,85 @@ typedef enum { AlignCenter, } Align; +/** Canvas Orientation */ typedef enum { CanvasOrientationHorizontal, CanvasOrientationVertical, } CanvasOrientation; +/** Canvas anonymouse structure */ typedef struct Canvas Canvas; -/* - * Canvas width - * @return width in pixels. +/** Get Canvas width + * + * @param canvas Canvas instance + * + * @return width in pixels. */ uint8_t canvas_width(Canvas* canvas); -/* - * Canvas height - * @return height in pixels. +/** Get Canvas height + * + * @param canvas Canvas instance + * + * @return height in pixels. */ uint8_t canvas_height(Canvas* canvas); -/* - * Get current font height - * @return height in pixels. +/** Get current font height + * + * @param canvas Canvas instance + * + * @return height in pixels. */ uint8_t canvas_current_font_height(Canvas* canvas); -/* - * Clear canvas, clear rendering buffer +/** Clear canvas + * + * @param canvas Canvas instance */ void canvas_clear(Canvas* canvas); -/* - * Set drawing color +/** Set drawing color + * + * @param canvas Canvas instance + * @param color Color */ void canvas_set_color(Canvas* canvas, Color color); -/* - * Invert drawing color +/** Invert drawing color + * + * @param canvas Canvas instance */ void canvas_invert_color(Canvas* canvas); -/* - * Set drawing font +/** Set drawing font + * + * @param canvas Canvas instance + * @param font Font */ void canvas_set_font(Canvas* canvas, Font font); -/* - * Draw string at position of baseline defined by x, y. +/** Draw string at position of baseline defined by x, y. + * + * @param canvas Canvas instance + * @param x anchor point x coordinate + * @param y anchor point y coordinate + * @param str C-string */ void canvas_draw_str(Canvas* canvas, uint8_t x, uint8_t y, const char* str); -/* - * Draw aligned string defined by x, y. - * Align calculated from position of baseline, string width and ascent (height of the glyphs above the baseline) +/** Draw aligned string defined by x, y. + * + * Align calculated from position of baseline, string width and ascent (height + * of the glyphs above the baseline) + * + * @param canvas Canvas instance + * @param x anchor point x coordinate + * @param y anchor point y coordinate + * @param horizontal horizontal alignment + * @param vertical vertical alignment + * @param str C-string */ void canvas_draw_str_aligned( Canvas* canvas, @@ -85,22 +119,30 @@ void canvas_draw_str_aligned( Align vertical, const char* str); -/* - * Get string width - * @return width in pixels. +/** Get string width + * + * @param canvas Canvas instance + * @param str C-string + * + * @return width in pixels. */ uint16_t canvas_string_width(Canvas* canvas, const char* str); /** Get glyph width - * @return width in pixels + * + * @param canvas Canvas instance + * @param[in] symbol character + * + * @return width in pixels */ uint8_t canvas_glyph_width(Canvas* canvas, char symbol); /** Draw animation at position defined by x,y. - * @param canvas - canvas instance - * @param x - x coordinate - * @param y - y coordinate - * @param icon_animation - data pointer to IconAnimation + * + * @param canvas Canvas instance + * @param x x coordinate + * @param y y coordinate + * @param icon_animation IconAnimation instance */ void canvas_draw_icon_animation( Canvas* canvas, @@ -109,15 +151,22 @@ void canvas_draw_icon_animation( IconAnimation* icon_animation); /** Draw icon at position defined by x,y. - * @param canvas - canvas instance - * @param x - x coordinate - * @param y - y coordinate - * @param icon - data pointer to Icon + * + * @param canvas Canvas instance + * @param x x coordinate + * @param y y coordinate + * @param icon Icon instance */ void canvas_draw_icon(Canvas* canvas, uint8_t x, uint8_t y, const Icon* icon); -/* - * Draw xbm icon of width, height at position defined by x,y. +/** Draw XBM bitmap + * + * @param canvas Canvas instance + * @param x x coordinate + * @param y y coordinate + * @param w bitmap width + * @param h bitmap height + * @param bitmap pointer to XBM bitmap data */ void canvas_draw_xbm( Canvas* canvas, @@ -127,48 +176,86 @@ void canvas_draw_xbm( uint8_t h, const uint8_t* bitmap); -/* - * Draw dot at x,y +/** Draw dot at x,y + * + * @param canvas Canvas instance + * @param x x coordinate + * @param y y coordinate */ void canvas_draw_dot(Canvas* canvas, uint8_t x, uint8_t y); -/* - * Draw box of width, height at x,y +/** Draw box of width, height at x,y + * + * @param canvas Canvas instance + * @param x x coordinate + * @param y y coordinate + * @param width box width + * @param height box height */ void canvas_draw_box(Canvas* canvas, uint8_t x, uint8_t y, uint8_t width, uint8_t height); -/* - * Draw frame of width, height at x,y +/** Draw frame of width, height at x,y + * + * @param canvas Canvas instance + * @param x x coordinate + * @param y y coordinate + * @param width frame width + * @param height frame height */ void canvas_draw_frame(Canvas* canvas, uint8_t x, uint8_t y, uint8_t width, uint8_t height); -/* - * Draw line from x1,y1 to x2,y2 +/** Draw line from x1,y1 to x2,y2 + * + * @param canvas Canvas instance + * @param x1 x1 coordinate + * @param y1 y1 coordinate + * @param x2 x2 coordinate + * @param y2 y2 coordinate */ void canvas_draw_line(Canvas* canvas, uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2); -/* - * Draw circle at x,y with radius r +/** Draw circle at x,y with radius r + * + * @param canvas Canvas instance + * @param x x coordinate + * @param y y coordinate + * @param r radius */ void canvas_draw_circle(Canvas* canvas, uint8_t x, uint8_t y, uint8_t r); -/* - * Draw disc at x,y with radius r +/** Draw disc at x,y with radius r + * + * @param canvas Canvas instance + * @param x x coordinate + * @param y y coordinate + * @param r radius */ void canvas_draw_disc(Canvas* canvas, uint8_t x, uint8_t y, uint8_t r); -/* - * Draw glyph +/** Draw glyph + * + * @param canvas Canvas instance + * @param x x coordinate + * @param y y coordinate + * @param ch character */ void canvas_draw_glyph(Canvas* canvas, uint8_t x, uint8_t y, uint16_t ch); -/* - * Set transparency mode +/** Set transparency mode + * + * @param canvas Canvas instance + * @param alpha transparency mode */ void canvas_set_bitmap_mode(Canvas* canvas, bool alpha); -/* - * Draw rounded-corner frame of width, height at x,y, with round value raduis +/** Draw rounded-corner frame of width, height at x,y, with round value raduis + * + * @param canvas Canvas instance + * @param x x coordinate + * @param y y coordinate + * @param width frame width + * @param height frame height + * @param radius frame corner radius */ void canvas_draw_rframe( Canvas* canvas, @@ -178,8 +265,14 @@ void canvas_draw_rframe( uint8_t height, uint8_t radius); -/* - * Draw rounded-corner box of width, height at x,y, with round value raduis +/** Draw rounded-corner box of width, height at x,y, with round value raduis + * + * @param canvas Canvas instance + * @param x x coordinate + * @param y y coordinate + * @param width box width + * @param height box height + * @param radius box corner radius */ void canvas_draw_rbox( Canvas* canvas, diff --git a/applications/gui/canvas_i.h b/applications/gui/canvas_i.h index e6cc63457..d5594c24a 100644 --- a/applications/gui/canvas_i.h +++ b/applications/gui/canvas_i.h @@ -1,8 +1,15 @@ +/** + * @file canvas_i.h + * GUI: internal Canvas API + */ + #pragma once #include "canvas.h" #include +/** Canvas structure + */ struct Canvas { u8g2_t fb; CanvasOrientation orientation; @@ -12,40 +19,53 @@ struct Canvas { uint8_t height; }; -/* - * Allocate memory and initialize canvas +/** Allocate memory and initialize canvas + * + * @return Canvas instance */ Canvas* canvas_init(); -/* - * Free canvas memory +/** Free canvas memory + * + * @param canvas Canvas instance */ void canvas_free(Canvas* canvas); -/* - * Reset canvas drawing tools configuration +/** Reset canvas drawing tools configuration + * + * @param canvas Canvas instance */ void canvas_reset(Canvas* canvas); -/* - * Commit canvas. Send buffer to display +/** Commit canvas. Send buffer to display + * + * @param canvas Canvas instance */ void canvas_commit(Canvas* canvas); -/* - * Get canvas buffer. - * @return pointer to buffer +/** Get canvas buffer. + * + * @param canvas Canvas instance + * + * @return pointer to buffer */ uint8_t* canvas_get_buffer(Canvas* canvas); -/* - * Get canvas buffer size. - * @return size of canvas in bytes +/** Get canvas buffer size. + * + * @param canvas Canvas instance + * + * @return size of canvas in bytes */ size_t canvas_get_buffer_size(Canvas* canvas); -/* - * Set drawing region relative to real screen buffer +/** Set drawing region relative to real screen buffer + * + * @param canvas Canvas instance + * @param offset_x x coordinate offset + * @param offset_y y coordinate offset + * @param width width + * @param height height */ void canvas_frame_set( Canvas* canvas, @@ -54,12 +74,17 @@ void canvas_frame_set( uint8_t width, uint8_t height); -/* - * Set canvas orientation +/** Set canvas orientation + * + * @param canvas Canvas instance + * @param orientation CanvasOrientation */ void canvas_set_orientation(Canvas* canvas, CanvasOrientation orientation); -/* - * Get canvas orientation +/** Get canvas orientation + * + * @param canvas Canvas instance + * + * @return CanvasOrientation */ CanvasOrientation canvas_get_orientation(const Canvas* canvas); diff --git a/applications/gui/elements.h b/applications/gui/elements.h index 04ad352ba..32156dc20 100644 --- a/applications/gui/elements.h +++ b/applications/gui/elements.h @@ -1,3 +1,11 @@ +/** + * @file elements.h + * GUI: Elements API + * + * Canvas helpers and UI building blocks. + * + */ + #pragma once #include diff --git a/applications/gui/gui.h b/applications/gui/gui.h index eb557bbcd..e94278b5c 100644 --- a/applications/gui/gui.h +++ b/applications/gui/gui.h @@ -1,3 +1,8 @@ +/** + * @file gui.h + * GUI: main API + */ + #pragma once #include "view_port.h" @@ -7,60 +12,74 @@ extern "C" { #endif -/* Gui layers */ +/** Gui layers */ typedef enum { - GuiLayerNone, /* Special layer for internal use only */ + GuiLayerNone, /**< Special layer for internal use only */ - GuiLayerStatusBarLeft, /* Status bar left-side layer, auto-layout */ - GuiLayerStatusBarRight, /* Status bar right-side layer, auto-layout */ - GuiLayerMain, /* Main layer, status bar is shown */ - GuiLayerFullscreen, /* Fullscreen layer */ + GuiLayerStatusBarLeft, /**< Status bar left-side layer, auto-layout */ + GuiLayerStatusBarRight, /**< Status bar right-side layer, auto-layout */ + GuiLayerMain, /**< Main layer, status bar is shown */ + GuiLayerFullscreen, /**< Fullscreen layer */ - GuiLayerMAX /* Don't use or move, special value */ + GuiLayerMAX /**< Don't use or move, special value */ } GuiLayer; -/* Gui frame buffer callback */ +/** Gui Canvas Commit Callback */ typedef void (*GuiCanvasCommitCallback)(uint8_t* data, size_t size, void* context); typedef struct Gui Gui; -/* - * Add view_port to view_port tree - * @remarks thread safe +/** Add view_port to view_port tree + * + * @remark thread safe + * + * @param gui Gui instance + * @param view_port ViewPort instance + * @param[in] layer GuiLayer where to place view_port */ void gui_add_view_port(Gui* gui, ViewPort* view_port, GuiLayer layer); -/* - * Remove view_port from rendering tree - * @remarks thread safe +/** Remove view_port from rendering tree + * + * @remark thread safe + * + * @param gui Gui instance + * @param view_port ViewPort instance */ void gui_remove_view_port(Gui* gui, ViewPort* view_port); -/* Send ViewPort to the front +/** Send ViewPort to the front + * * Places selected ViewPort to the top of the drawing stack - * @param gui - Gui instance - * @param view_port - ViewPort instance + * + * @param gui Gui instance + * @param view_port ViewPort instance */ void gui_send_view_port_front(Gui* gui, ViewPort* view_port); -/* Send ViewPort to the back +/** Send ViewPort to the back + * * Places selected ViewPort to the bottom of the drawing stack - * @param gui - Gui instance - * @param view_port - ViewPort instance + * + * @param gui Gui instance + * @param view_port ViewPort instance */ void gui_send_view_port_back(Gui* gui, ViewPort* view_port); -/* Set gui canvas commit callback - * This callback will be called upon Canvas commit - * Callback dispatched from GUI thread and is time critical - * @param gui - Gui instance - * @param callback - GuiCanvasCommitCallback +/** Set gui canvas commit callback + * + * This callback will be called upon Canvas commit Callback dispatched from GUI + * thread and is time critical + * + * @param gui Gui instance + * @param callback GuiCanvasCommitCallback */ void gui_set_framebuffer_callback(Gui* gui, GuiCanvasCommitCallback callback); -/* Set gui canvas commit callback context - * @param gui - Gui instance - * @param context - pointer to context +/** Set gui canvas commit callback context + * + * @param gui Gui instance + * @param context pointer to context */ void gui_set_framebuffer_callback_context(Gui* gui, void* context); diff --git a/applications/gui/gui_i.h b/applications/gui/gui_i.h index d67b4599b..cfbf604f7 100644 --- a/applications/gui/gui_i.h +++ b/applications/gui/gui_i.h @@ -1,3 +1,8 @@ +/** + * @file gui_i.h + * GUI: main API internals + */ + #pragma once #include "gui.h" @@ -31,6 +36,7 @@ ARRAY_DEF(ViewPortArray, ViewPort*, M_PTR_OPLIST); +/** Gui structure */ struct Gui { // Thread and lock osThreadId_t thread; @@ -54,8 +60,9 @@ struct Gui { ViewPort* gui_view_port_find_enabled(ViewPortArray_t array); -/* Update GUI, request redraw - * @param gui, Gui instance +/** Update GUI, request redraw + * + * @param gui Gui instance */ void gui_update(Gui* gui); @@ -67,4 +74,4 @@ void gui_unlock(Gui* gui); void gui_cli_screen_stream_callback(uint8_t* data, size_t size, void* context); -void gui_cli_screen_stream(Cli* cli, string_t args, void* context); \ No newline at end of file +void gui_cli_screen_stream(Cli* cli, string_t args, void* context); diff --git a/applications/gui/icon.h b/applications/gui/icon.h index 058089bb9..ebe40266b 100644 --- a/applications/gui/icon.h +++ b/applications/gui/icon.h @@ -1,3 +1,8 @@ +/** + * @file icon.h + * GUI: Icon API + */ + #pragma once #include @@ -8,10 +13,28 @@ extern "C" { typedef struct Icon Icon; +/** Get icon width + * + * @param[in] instance pointer to Icon data + * + * @return width in pixels + */ uint8_t icon_get_width(const Icon* instance); +/** Get icon height + * + * @param[in] instance pointer to Icon data + * + * @return height in pixels + */ uint8_t icon_get_height(const Icon* instance); +/** Get Icon XBM bitmap data + * + * @param[in] instance pointer to Icon data + * + * @return pointer to XBM bitmap data + */ const uint8_t* icon_get_data(const Icon* instance); #ifdef __cplusplus diff --git a/applications/gui/icon_animation.h b/applications/gui/icon_animation.h index 6adc16ece..dab9d996d 100644 --- a/applications/gui/icon_animation.h +++ b/applications/gui/icon_animation.h @@ -1,28 +1,48 @@ +/** + * @file icon_animation.h + * GUI: IconAnimation API + */ + #pragma once #include #include +#include #ifdef __cplusplus extern "C" { #endif -#include - +/** Icon Animation */ typedef struct IconAnimation IconAnimation; +/** Icon Animation Callback. Used for update notification */ typedef void (*IconAnimationCallback)(IconAnimation* instance, void* context); /** Allocate icon animation instance with const icon data. + * * always returns Icon or stops system if not enough memory + * + * @param[in] icon pointer to Icon data + * + * @return IconAnimation instance */ IconAnimation* icon_animation_alloc(const Icon* icon); /** Release icon animation instance + * + * @param instance IconAnimation instance */ void icon_animation_free(IconAnimation* instance); -/** Get icon animation width +/** Set IconAnimation update callback + * + * Normally you do not need to use this function, use view_tie_icon_animation + * instead. + * + * @param instance IconAnimation instance + * @param[in] callback IconAnimationCallback + * @param context callback context */ void icon_animation_set_update_callback( IconAnimation* instance, @@ -30,22 +50,38 @@ void icon_animation_set_update_callback( void* context); /** Get icon animation width + * + * @param instance IconAnimation instance + * + * @return width in pixels */ uint8_t icon_animation_get_width(IconAnimation* instance); /** Get icon animation height + * + * @param instance IconAnimation instance + * + * @return height in pixels */ uint8_t icon_animation_get_height(IconAnimation* instance); /** Start icon animation + * + * @param instance IconAnimation instance */ void icon_animation_start(IconAnimation* instance); /** Stop icon animation + * + * @param instance IconAnimation instance */ void icon_animation_stop(IconAnimation* instance); /** Returns true if current frame is a last one + * + * @param instance IconAnimation instance + * + * @return true if last frame */ bool icon_animation_is_last_frame(IconAnimation* instance); diff --git a/applications/gui/icon_animation_i.h b/applications/gui/icon_animation_i.h index 61c74788e..241bcaa38 100644 --- a/applications/gui/icon_animation_i.h +++ b/applications/gui/icon_animation_i.h @@ -1,3 +1,8 @@ +/** + * @file icon_animation_i.h + * GUI: internal IconAnimation API + */ + #pragma once #include "icon_animation.h" @@ -13,11 +18,22 @@ struct IconAnimation { void* callback_context; }; -/** Get pointer to current frame data */ +/** Get pointer to current frame data + * + * @param instance IconAnimation instance + * + * @return pointer to current frame XBM bitmap data + */ const uint8_t* icon_animation_get_data(IconAnimation* instance); -/** Advance to next frame */ +/** Advance to next frame + * + * @param instance IconAnimation instance + */ void icon_animation_next_frame(IconAnimation* instance); -/** IconAnimation timer callback */ +/** IconAnimation timer callback + * + * @param context pointer to IconAnimation + */ void icon_animation_timer_callback(void* context); diff --git a/applications/gui/icon_i.h b/applications/gui/icon_i.h index 62a7ff395..c01f5cce5 100644 --- a/applications/gui/icon_i.h +++ b/applications/gui/icon_i.h @@ -1,3 +1,8 @@ +/** + * @file icon_i.h + * GUI: internal Icon API + */ + #include "icon.h" struct Icon { diff --git a/applications/gui/modules/button_menu.h b/applications/gui/modules/button_menu.h index 35355d6bf..a662114b0 100644 --- a/applications/gui/modules/button_menu.h +++ b/applications/gui/modules/button_menu.h @@ -1,4 +1,10 @@ +/** + * @file button_menu.h + * GUI: ButtonMenu view module API + */ + #pragma once + #include #include @@ -6,40 +12,48 @@ extern "C" { #endif -/* ButtonMenu anonymous structure */ +/** ButtonMenu anonymous structure */ typedef struct ButtonMenu ButtonMenu; + +/** ButtonMenuItem anonymous structure */ typedef struct ButtonMenuItem ButtonMenuItem; -/* Callback for any button menu actions */ +/** Callback for any button menu actions */ typedef void (*ButtonMenuItemCallback)(void* context, int32_t index, InputType type); -/* Type of button. Difference in drawing buttons. */ +/** Type of button. Difference in drawing buttons. */ typedef enum { ButtonMenuItemTypeCommon, ButtonMenuItemTypeControl, } ButtonMenuItemType; -/** - * @brief Get button menu view - * @param button_menu - ButtonMenu instance - * @return View instance that can be used for embedding +/** Get button menu view + * + * @param button_menu ButtonMenu instance + * + * @return View instance that can be used for embedding */ View* button_menu_get_view(ButtonMenu* button_menu); -/** - * @brief Clean button menu - * @param button_menu - ButtonMenu instance +/** Clean button menu + * + * @param button_menu ButtonMenu instance */ void button_menu_clean(ButtonMenu* button_menu); -/** - * @brief Add item to button menu instance - * @param button_menu - ButtonMenu instance - * @param label - text inside new button - * @param index - value to distinct between buttons inside ButtonMenuItemCallback - * @param type - type of button to create. Differ by button drawing. - * Control buttons have no frames, and have more squared borders. - * @return pointer to just-created item +/** Add item to button menu instance + * + * @param button_menu ButtonMenu instance + * @param label text inside new button + * @param index value to distinct between buttons inside + * ButtonMenuItemCallback + * @param callback The callback + * @param type type of button to create. Differ by button + * drawing. Control buttons have no frames, and + * have more squared borders. + * @param callback_context The callback context + * + * @return pointer to just-created item */ ButtonMenuItem* button_menu_add_item( ButtonMenu* button_menu, @@ -49,29 +63,29 @@ ButtonMenuItem* button_menu_add_item( ButtonMenuItemType type, void* callback_context); -/** - * @brief Allocate and initialize new instance of ButtonMenu model - * @return just-created ButtonMenu model +/** Allocate and initialize new instance of ButtonMenu model + * + * @return just-created ButtonMenu model */ ButtonMenu* button_menu_alloc(void); -/** - * @brief Free ButtonMenu element - * @param button_menu - ButtonMenu instance +/** Free ButtonMenu element + * + * @param button_menu ButtonMenu instance */ void button_menu_free(ButtonMenu* button_menu); -/** - * @brief Set ButtonMenu header on top of canvas - * @param button_menu - ButtonMenu instance - * @param header - header on the top of button menu +/** Set ButtonMenu header on top of canvas + * + * @param button_menu ButtonMenu instance + * @param header header on the top of button menu */ void button_menu_set_header(ButtonMenu* button_menu, const char* header); -/** - * @brief Set selected item - * @param button_menu - ButtonMenu instance - * @param index - index of ButtonMenu to be selected +/** Set selected item + * + * @param button_menu ButtonMenu instance + * @param index index of ButtonMenu to be selected */ void button_menu_set_selected_item(ButtonMenu* button_menu, uint32_t index); diff --git a/applications/gui/modules/button_panel.h b/applications/gui/modules/button_panel.h index 647b3c6ef..479aeeaf5 100644 --- a/applications/gui/modules/button_panel.h +++ b/applications/gui/modules/button_panel.h @@ -1,4 +1,10 @@ +/** + * @file button_panel.h + * GUI: ButtonPanel view module API + */ + #pragma once + #include #ifdef __cplusplus @@ -10,37 +16,39 @@ typedef struct ButtonPanel ButtonPanel; /** Callback type to call for handling selecting button_panel items */ typedef void (*ButtonItemCallback)(void* context, uint32_t index); + /** Callback type for additional drawings above main button_panel screen */ typedef void (*ButtonPanelDrawCallback)(Canvas* canvas, void* _model); + /** Callback type to intercept input events of button_panel */ typedef bool (*ButtonPanelInputCallback)(InputEvent* event, void* context); /** Allocate new button_panel module. * - * @return just-created module + * @return ButtonPanel instance */ ButtonPanel* button_panel_alloc(void); /** Free button_panel module. * - * @param button_panel - module to free + * @param button_panel ButtonPanel instance */ void button_panel_free(ButtonPanel* button_panel); /** Free items from button_panel module. Preallocated matrix stays unchanged. * - * @param button_panel - module to clean + * @param button_panel ButtonPanel instance */ void button_panel_clean(ButtonPanel* button_panel); /** Reserve space for adding items. * - * One does not simply use button_panel_add_item() without this function. - * It should be allocated space for it first. + * One does not simply use button_panel_add_item() without this function. It + * should be allocated space for it first. * - * @param button_panel - module to modify - * @param reserve_x - number of columns in button_panel - * @param reserve_y - number of rows in button_panel + * @param button_panel ButtonPanel instance + * @param reserve_x number of columns in button_panel + * @param reserve_y number of rows in button_panel */ void button_panel_reserve(ButtonPanel* button_panel, size_t reserve_x, size_t reserve_y); @@ -48,20 +56,20 @@ void button_panel_reserve(ButtonPanel* button_panel, size_t reserve_x, size_t re * * Have to set element in bounds of allocated size by X and by Y. * - * @param button_panel - module - * @param index - value to pass to callback - * @param matrix_place_x - coordinates by x-axis on virtual grid, it - * is only used for naviagation - * @param matrix_place_y - coordinates by y-axis on virtual grid, it - * is only used for naviagation - * @param x - x-coordinate to draw icon on - * @param y - y-coordinate to draw icon on - * @param icon_name - name of the icon to draw - * @param icon_name_selected - name of the icon to draw when current - * element is selected - * @param callback - function to call when specific element is selected - * (pressed Ok on selected item) - * @param callback_context - context to pass to callback + * @param button_panel ButtonPanel instance + * @param index value to pass to callback + * @param matrix_place_x coordinates by x-axis on virtual grid, it + * is only used for naviagation + * @param matrix_place_y coordinates by y-axis on virtual grid, it + * is only used for naviagation + * @param x x-coordinate to draw icon on + * @param y y-coordinate to draw icon on + * @param icon_name name of the icon to draw + * @param icon_name_selected name of the icon to draw when current + * element is selected + * @param callback function to call when specific element is + * selected (pressed Ok on selected item) + * @param callback_context context to pass to callback */ void button_panel_add_item( ButtonPanel* button_panel, @@ -77,17 +85,19 @@ void button_panel_add_item( /** Get button_panel view. * - * @param button_panel - module to get view from - * @return acquired view + * @param button_panel ButtonPanel instance + * + * @return acquired view */ View* button_panel_get_view(ButtonPanel* button_panel); /** Add label to button_panel module. * - * @param x - x-coordinate to place label - * @param y - y-coordinate to place label - * @param font - font to write label with - * @param label_str - string label to write + * @param button_panel ButtonPanel instance + * @param x x-coordinate to place label + * @param y y-coordinate to place label + * @param font font to write label with + * @param label_str string label to write */ void button_panel_add_label( ButtonPanel* button_panel, @@ -101,9 +111,9 @@ void button_panel_add_label( * * Used to add popup drawings after main draw callback is done. * - * @param button_panel - module to modify - * @param callback - callback function to set for draw event - * @param context - context to pass to callback + * @param button_panel ButtonPanel instance + * @param callback callback function to set for draw event + * @param context context to pass to callback */ void button_panel_set_popup_draw_callback( ButtonPanel* button_panel, @@ -112,12 +122,12 @@ void button_panel_set_popup_draw_callback( /** Set popup input callback for button_panel module. * - * Used to add popup input callback. It will intercept all input - * events for current view. + * Used to add popup input callback. It will intercept all input events for + * current view. * - * @param button_panel - module to modify - * @param callback - function to overwrite main input callbacks - * @param context - context to pass to callback + * @param button_panel ButtonPanel instance + * @param callback function to overwrite main input callbacks + * @param context context to pass to callback */ void button_panel_set_popup_input_callback( ButtonPanel* button_panel, diff --git a/applications/gui/modules/byte_input.h b/applications/gui/modules/byte_input.h index 347474df6..b2f94f3ca 100644 --- a/applications/gui/modules/byte_input.h +++ b/applications/gui/modules/byte_input.h @@ -1,59 +1,53 @@ +/** + * @file byte_input.h + * GUI: ByteInput keyboard view module API + */ + #pragma once + #include #ifdef __cplusplus extern "C" { #endif -/** - * @brief Byte input anonymous structure - * - */ +/** Byte input anonymous structure */ typedef struct ByteInput ByteInput; -/** - * @brief callback that is executed on save button press - * - */ +/** callback that is executed on save button press */ typedef void (*ByteInputCallback)(void* context); -/** - * @brief callback that is executed when byte buffer is changed - * - */ +/** callback that is executed when byte buffer is changed */ typedef void (*ByteChangedCallback)(void* context); -/** - * @brief Allocate and initialize byte input. This byte input is used to enter bytes. - * - * @return ByteInput instance pointer +/** Allocate and initialize byte input. This byte input is used to enter bytes. + * + * @return ByteInput instance pointer */ ByteInput* byte_input_alloc(); -/** - * @brief Deinitialize and free byte input - * - * @param byte_input Byte input instance +/** Deinitialize and free byte input + * + * @param byte_input Byte input instance */ void byte_input_free(ByteInput* byte_input); -/** - * @brief Get byte input view - * - * @param byte_input byte input instance - * @return View instance that can be used for embedding +/** Get byte input view + * + * @param byte_input byte input instance + * + * @return View instance that can be used for embedding */ View* byte_input_get_view(ByteInput* byte_input); -/** - * @brief Set byte input result callback - * - * @param byte_input byte input instance - * @param input_callback input callback fn - * @param changed_callback changed callback fn - * @param callback_context callback context - * @param bytes buffer to use - * @param bytes_count buffer length +/** Set byte input result callback + * + * @param byte_input byte input instance + * @param input_callback input callback fn + * @param changed_callback changed callback fn + * @param callback_context callback context + * @param bytes buffer to use + * @param bytes_count buffer length */ void byte_input_set_result_callback( ByteInput* byte_input, @@ -63,11 +57,10 @@ void byte_input_set_result_callback( uint8_t* bytes, uint8_t bytes_count); -/** - * @brief Set byte input header text - * - * @param byte_input byte input instance - * @param text text to be shown +/** Set byte input header text + * + * @param byte_input byte input instance + * @param text text to be shown */ void byte_input_set_header_text(ByteInput* byte_input, const char* text); diff --git a/applications/gui/modules/dialog.h b/applications/gui/modules/dialog.h index 5fae73fe0..e9160a351 100644 --- a/applications/gui/modules/dialog.h +++ b/applications/gui/modules/dialog.h @@ -1,77 +1,95 @@ +/** + * @file dialog.h + * GUI: Dialog view module API + */ + #pragma once + #include #ifdef __cplusplus extern "C" { #endif -/* Dialog anonymous structure */ +/** Dialog anonymous structure */ typedef struct Dialog Dialog; -/* Dialog result */ +/** Dialog result */ typedef enum { DialogResultLeft, DialogResultRight, DialogResultBack, } DialogResult; -/* Dialog result callback type - * @warning comes from GUI thread +/** Dialog result callback type + * @warning comes from GUI thread */ typedef void (*DialogResultCallback)(DialogResult result, void* context); -/* Allocate and initialize dialog +/** Allocate and initialize dialog + * * This dialog used to ask simple questions like Yes/ + * + * @return Dialog instance */ Dialog* dialog_alloc(); -/* Deinitialize and free dialog - * @param dialog - Dialog instance +/** Deinitialize and free dialog + * + * @param dialog Dialog instance */ void dialog_free(Dialog* dialog); -/* Get dialog view - * @param dialog - Dialog instance - * @return View instance that can be used for embedding +/** Get dialog view + * + * @param dialog Dialog instance + * + * @return View instance that can be used for embedding */ View* dialog_get_view(Dialog* dialog); -/* Set dialog result callback - * @param dialog - Dialog instance - * @param callback - result callback function +/** Set dialog result callback + * + * @param dialog Dialog instance + * @param callback result callback function */ void dialog_set_result_callback(Dialog* dialog, DialogResultCallback callback); -/* Set dialog context - * @param dialog - Dialog instance - * @param context - context pointer, will be passed to result callback +/** Set dialog context + * + * @param dialog Dialog instance + * @param context context pointer, will be passed to result callback */ void dialog_set_context(Dialog* dialog, void* context); -/* Set dialog header text - * @param dialog - Dialog instance - * @param text - text to be shown +/** Set dialog header text + * + * @param dialog Dialog instance + * @param text text to be shown */ void dialog_set_header_text(Dialog* dialog, const char* text); -/* Set dialog text - * @param dialog - Dialog instance - * @param text - text to be shown +/** Set dialog text + * + * @param dialog Dialog instance + * @param text text to be shown */ void dialog_set_text(Dialog* dialog, const char* text); -/* Set left button text - * @param dialog - Dialog instance - * @param text - text to be shown +/** Set left button text + * + * @param dialog Dialog instance + * @param text text to be shown */ void dialog_set_left_button_text(Dialog* dialog, const char* text); -/* Set right button text - * @param dialog - Dialog instance - * @param text - text to be shown +/** Set right button text + * + * @param dialog Dialog instance + * @param text text to be shown */ void dialog_set_right_button_text(Dialog* dialog, const char* text); #ifdef __cplusplus } -#endif \ No newline at end of file +#endif diff --git a/applications/gui/modules/dialog_ex.h b/applications/gui/modules/dialog_ex.h index 7833128aa..1420fe5f7 100644 --- a/applications/gui/modules/dialog_ex.h +++ b/applications/gui/modules/dialog_ex.h @@ -1,4 +1,10 @@ +/** + * @file dialog_ex.h + * GUI: DialogEx view module API + */ + #pragma once + #include #ifdef __cplusplus @@ -21,40 +27,51 @@ typedef enum { typedef void (*DialogExResultCallback)(DialogExResult result, void* context); /** Allocate and initialize dialog + * * This dialog used to ask simple questions - * @return DialogEx instance + * + * @return DialogEx instance */ DialogEx* dialog_ex_alloc(); /** Deinitialize and free dialog - * @param dialog - DialogEx instance + * + * @param dialog_ex DialogEx instance */ void dialog_ex_free(DialogEx* dialog_ex); /** Get dialog view - * @param dialog - DialogEx instance - * @return View instance that can be used for embedding + * + * @param dialog_ex DialogEx instance + * + * @return View instance that can be used for embedding */ View* dialog_ex_get_view(DialogEx* dialog_ex); /** Set dialog result callback - * @param dialog_ex - DialogEx instance - * @param callback - result callback function + * + * @param dialog_ex DialogEx instance + * @param callback result callback function */ void dialog_ex_set_result_callback(DialogEx* dialog_ex, DialogExResultCallback callback); /** Set dialog context - * @param dialog_ex - DialogEx instance - * @param context - context pointer, will be passed to result callback + * + * @param dialog_ex DialogEx instance + * @param context context pointer, will be passed to result callback */ void dialog_ex_set_context(DialogEx* dialog_ex, void* context); /** Set dialog header text + * * If text is null, dialog header will not be rendered - * @param dialog - DialogEx instance - * @param text - text to be shown, can be multiline - * @param x, y - text position - * @param horizontal, vertical - text aligment + * + * @param dialog_ex DialogEx instance + * @param text text to be shown, can be multiline + * @param x x position + * @param y y position + * @param horizontal horizontal text aligment + * @param vertical vertical text aligment */ void dialog_ex_set_header( DialogEx* dialog_ex, @@ -65,11 +82,15 @@ void dialog_ex_set_header( Align vertical); /** Set dialog text + * * If text is null, dialog text will not be rendered - * @param dialog - DialogEx instance - * @param text - text to be shown, can be multiline - * @param x, y - text position - * @param horizontal, vertical - text aligment + * + * @param dialog_ex DialogEx instance + * @param text text to be shown, can be multiline + * @param x x position + * @param y y position + * @param horizontal horizontal text aligment + * @param vertical vertical text aligment */ void dialog_ex_set_text( DialogEx* dialog_ex, @@ -80,36 +101,47 @@ void dialog_ex_set_text( Align vertical); /** Set dialog icon + * * If x or y is negative, dialog icon will not be rendered - * @param dialog - DialogEx instance - * @param x, y - icon position - * @param name - icon to be shown + * + * @param dialog_ex DialogEx instance + * @param x x position + * @param y y position + * @param icon The icon + * @param name icon to be shown */ void dialog_ex_set_icon(DialogEx* dialog_ex, uint8_t x, uint8_t y, const Icon* icon); /** Set left button text + * * If text is null, left button will not be rendered and processed - * @param dialog - DialogEx instance - * @param text - text to be shown + * + * @param dialog_ex DialogEx instance + * @param text text to be shown */ void dialog_ex_set_left_button_text(DialogEx* dialog_ex, const char* text); /** Set center button text + * * If text is null, center button will not be rendered and processed - * @param dialog - DialogEx instance - * @param text - text to be shown + * + * @param dialog_ex DialogEx instance + * @param text text to be shown */ void dialog_ex_set_center_button_text(DialogEx* dialog_ex, const char* text); /** Set right button text + * * If text is null, right button will not be rendered and processed - * @param dialog - DialogEx instance - * @param text - text to be shown + * + * @param dialog_ex DialogEx instance + * @param text text to be shown */ void dialog_ex_set_right_button_text(DialogEx* dialog_ex, const char* text); /** Clean dialog - * @param dialog_ex DialogEx instance + * + * @param dialog_ex DialogEx instance */ void dialog_ex_clean(DialogEx* dialog_ex); diff --git a/applications/gui/modules/empty_screen.h b/applications/gui/modules/empty_screen.h index a0b562198..43d2fe049 100644 --- a/applications/gui/modules/empty_screen.h +++ b/applications/gui/modules/empty_screen.h @@ -1,26 +1,38 @@ +/** + * @file empty_screen.h + * GUI: EmptyScreen view module API + */ + #pragma once + #include #ifdef __cplusplus extern "C" { #endif -/* Empty screen anonymous structure */ +/** Empty screen anonymous structure */ typedef struct EmptyScreen EmptyScreen; -/* Allocate and initialize empty screen +/** Allocate and initialize empty screen + * * This empty screen used to ask simple questions like Yes/ + * + * @return EmptyScreen instance */ EmptyScreen* empty_screen_alloc(); -/* Deinitialize and free empty screen - * @param empty_screen - Empty screen instance +/** Deinitialize and free empty screen + * + * @param empty_screen Empty screen instance */ void empty_screen_free(EmptyScreen* empty_screen); -/* Get empty screen view - * @param empty_screen - Empty screen instance - * @return View instance that can be used for embedding +/** Get empty screen view + * + * @param empty_screen Empty screen instance + * + * @return View instance that can be used for embedding */ View* empty_screen_get_view(EmptyScreen* empty_screen); diff --git a/applications/gui/modules/file_select.h b/applications/gui/modules/file_select.h index 5f666d5a0..7318c87c7 100644 --- a/applications/gui/modules/file_select.h +++ b/applications/gui/modules/file_select.h @@ -1,4 +1,10 @@ +/** + * @file file_select.h + * GUI: FileSelect view module API + */ + #pragma once + #include #ifdef __cplusplus diff --git a/applications/gui/modules/menu.h b/applications/gui/modules/menu.h index 26c83c0c3..e7d52c84d 100755 --- a/applications/gui/modules/menu.h +++ b/applications/gui/modules/menu.h @@ -1,4 +1,10 @@ +/** + * @file menu.h + * GUI: Menu view module API + */ + #pragma once + #include #ifdef __cplusplus @@ -7,31 +13,38 @@ extern "C" { /** Menu anonymous structure */ typedef struct Menu Menu; + +/** Menu Item Callback */ typedef void (*MenuItemCallback)(void* context, uint32_t index); /** Menu allocation and initialization - * @return Menu instance + * + * @return Menu instance */ Menu* menu_alloc(); /** Free menu - * @param menu - Menu instance + * + * @param menu Menu instance */ void menu_free(Menu* menu); /** Get Menu view - * @param menu - Menu instance - * @return View instance + * + * @param menu Menu instance + * + * @return View instance */ View* menu_get_view(Menu* menu); /** Add item to menu - * @param menu - Menu instance - * @param label - menu item string label - * @param icon - IconAnimation instance - * @param index - menu item index - * @param callback - MenuItemCallback instance - * @param context - pointer to context + * + * @param menu Menu instance + * @param label menu item string label + * @param icon IconAnimation instance + * @param index menu item index + * @param callback MenuItemCallback instance + * @param context pointer to context */ void menu_add_item( Menu* menu, @@ -42,14 +55,16 @@ void menu_add_item( void* context); /** Clean menu - * Note: this function does not free menu instance - * @param menu - Menu instance + * @note this function does not free menu instance + * + * @param menu Menu instance */ void menu_clean(Menu* menu); /** Set current menu item - * @param submenu - * @param index + * + * @param menu Menu instance + * @param index The index */ void menu_set_selected_item(Menu* menu, uint32_t index); diff --git a/applications/gui/modules/popup.h b/applications/gui/modules/popup.h index d65ce4c89..2b87f0ad5 100644 --- a/applications/gui/modules/popup.h +++ b/applications/gui/modules/popup.h @@ -1,52 +1,70 @@ +/** + * @file popup.h + * GUI: Popup view module API + */ + #pragma once + #include #ifdef __cplusplus extern "C" { #endif -/* Popup anonymous structure */ +/** Popup anonymous structure */ typedef struct Popup Popup; -/* Popup result callback type - * @warning comes from GUI thread +/** Popup result callback type + * @warning comes from GUI thread */ typedef void (*PopupCallback)(void* context); -/* Allocate and initialize popup +/** Allocate and initialize popup + * * This popup used to ask simple questions like Yes/ + * + * @return Popup instance */ Popup* popup_alloc(); -/* Deinitialize and free popup - * @param popup - Popup instance +/** Deinitialize and free popup + * + * @param popup Popup instance */ void popup_free(Popup* popup); -/* Get popup view - * @param popup - Popup instance - * @return View instance that can be used for embedding +/** Get popup view + * + * @param popup Popup instance + * + * @return View instance that can be used for embedding */ View* popup_get_view(Popup* popup); -/* Set popup header text - * @param popup - Popup instance - * @param text - text to be shown +/** Set popup header text + * + * @param popup Popup instance + * @param callback PopupCallback */ void popup_set_callback(Popup* popup, PopupCallback callback); -/* Set popup context - * @param popup - Popup instance - * @param context - context pointer, will be passed to result callback +/** Set popup context + * + * @param popup Popup instance + * @param context context pointer, will be passed to result callback */ void popup_set_context(Popup* popup, void* context); -/* Set popup header text +/** Set popup header text + * * If text is null, popup header will not be rendered - * @param popup - Popup instance - * @param text - text to be shown, can be multiline - * @param x, y - text position - * @param horizontal, vertical - text aligment + * + * @param popup Popup instance + * @param text text to be shown, can be multiline + * @param x x position + * @param y y position + * @param horizontal horizontal alignment + * @param vertical vertical aligment */ void popup_set_header( Popup* popup, @@ -56,12 +74,16 @@ void popup_set_header( Align horizontal, Align vertical); -/* Set popup text +/** Set popup text + * * If text is null, popup text will not be rendered - * @param popup - Popup instance - * @param text - text to be shown, can be multiline - * @param x, y - text position - * @param horizontal, vertical - text aligment + * + * @param popup Popup instance + * @param text text to be shown, can be multiline + * @param x x position + * @param y y position + * @param horizontal horizontal alignment + * @param vertical vertical aligment */ void popup_set_text( Popup* popup, @@ -71,30 +93,36 @@ void popup_set_text( Align horizontal, Align vertical); -/* Set popup icon +/** Set popup icon + * * If icon position is negative, popup icon will not be rendered - * @param popup - Popup instance - * @param x, y - icon position - * @param name - icon to be shown + * + * @param popup Popup instance + * @param x x position + * @param y y position + * @param icon pointer to Icon data */ void popup_set_icon(Popup* popup, uint8_t x, uint8_t y, const Icon* icon); -/* Set popup timeout - * @param popup - Popup instance - * @param timeout_in_ms - popup timeout value in milliseconds +/** Set popup timeout + * + * @param popup Popup instance + * @param timeout_in_ms popup timeout value in milliseconds */ void popup_set_timeout(Popup* popup, uint32_t timeout_in_ms); -/* Enable popup timeout - * @param popup - Popup instance +/** Enable popup timeout + * + * @param popup Popup instance */ void popup_enable_timeout(Popup* popup); -/* Disable popup timeout - * @param popup - Popup instance +/** Disable popup timeout + * + * @param popup Popup instance */ void popup_disable_timeout(Popup* popup); #ifdef __cplusplus } -#endif \ No newline at end of file +#endif diff --git a/applications/gui/modules/submenu.h b/applications/gui/modules/submenu.h index 50a9211e1..fac29e153 100644 --- a/applications/gui/modules/submenu.h +++ b/applications/gui/modules/submenu.h @@ -1,40 +1,50 @@ +/** + * @file submenu.h + * GUI: SubMenu view module API + */ + #pragma once + #include #ifdef __cplusplus extern "C" { #endif -/* Submenu anonymous structure */ +/** Submenu anonymous structure */ typedef struct Submenu Submenu; typedef void (*SubmenuItemCallback)(void* context, uint32_t index); -/** - * @brief Allocate and initialize submenu +/** Allocate and initialize submenu + * * This submenu is used to select one option + * + * @return Submenu instance */ Submenu* submenu_alloc(); -/** - * @brief Deinitialize and free submenu - * @param submenu - Submenu instance +/** Deinitialize and free submenu + * + * @param submenu Submenu instance */ void submenu_free(Submenu* submenu); -/** - * @brief Get submenu view - * @param submenu - Submenu instance - * @return View instance that can be used for embedding +/** Get submenu view + * + * @param submenu Submenu instance + * + * @return View instance that can be used for embedding */ View* submenu_get_view(Submenu* submenu); -/** - * @brief Add item to submenu - * @param submenu - Submenu instance - * @param label - menu item label - * @param index - menu item index, used for callback, may be the same with other items - * @param callback - menu item callback - * @param callback_context - menu item callback context +/** Add item to submenu + * + * @param submenu Submenu instance + * @param label menu item label + * @param index menu item index, used for callback, may be + * the same with other items + * @param callback menu item callback + * @param callback_context menu item callback context */ void submenu_add_item( Submenu* submenu, @@ -43,23 +53,23 @@ void submenu_add_item( SubmenuItemCallback callback, void* callback_context); -/** - * @brief Remove all items from submenu - * @param submenu - Submenu instance +/** Remove all items from submenu + * + * @param submenu Submenu instance */ void submenu_clean(Submenu* submenu); -/** - * @brief Set submenu item selector - * @param submenu - * @param index +/** Set submenu item selector + * + * @param submenu Submenu instance + * @param index The index */ void submenu_set_selected_item(Submenu* submenu, uint32_t index); -/** - * @brief Set optional header for submenu - * @param submenu - submenu entity - * @param header - header to set +/** Set optional header for submenu + * + * @param submenu Submenu instance + * @param header header to set */ void submenu_set_header(Submenu* submenu, const char* header); diff --git a/applications/gui/modules/text_box.h b/applications/gui/modules/text_box.h index e2bfc34f0..9aaa04855 100644 --- a/applications/gui/modules/text_box.h +++ b/applications/gui/modules/text_box.h @@ -1,11 +1,17 @@ +/** + * @file text_box.h + * GUI: TextBox view module API + */ + #pragma once + #include #ifdef __cplusplus extern "C" { #endif -/* TextBox anonymous structure */ +/** TextBox anonymous structure */ typedef struct TextBox TextBox; typedef void (*TextBoxExitCallback)(void* context); @@ -15,46 +21,56 @@ typedef enum { } TextBoxFont; /** Allocate and initialize text_box + * + * @return TextBox instance */ TextBox* text_box_alloc(); /** Deinitialize and free text_box - * @param text_box text_box instance + * + * @param text_box text_box instance */ void text_box_free(TextBox* text_box); /** Get text_box view - * @param text_box TextBox instance - * @return View instance that can be used for embedding + * + * @param text_box TextBox instance + * + * @return View instance that can be used for embedding */ View* text_box_get_view(TextBox* text_box); /** Clean text_box - * @param text_box TextBox instance + * + * @param text_box TextBox instance */ void text_box_clean(TextBox* text_box); /** Set text for text_box - * @param text_box TextBox instance - * @param text text to set + * + * @param text_box TextBox instance + * @param text text to set */ void text_box_set_text(TextBox* text_box, const char* text); /** Set TextBox font - * @param text_box TextBox instance - * @param font TextBoxFont instance + * + * @param text_box TextBox instance + * @param font TextBoxFont instance */ void text_box_set_font(TextBox* text_box, TextBoxFont font); /** Set text_box context - * @param text_box TextBox instance - * @param context context pointer + * + * @param text_box TextBox instance + * @param context context pointer */ void text_box_set_context(TextBox* text_box, void* context); /** Set exit callback - * @param text_box TextBox instance - * @param callback TextBoxExitCallback callback pointer + * + * @param text_box TextBox instance + * @param callback TextBoxExitCallback callback pointer */ void text_box_set_exit_callback(TextBox* text_box, TextBoxExitCallback callback); diff --git a/applications/gui/modules/text_input.h b/applications/gui/modules/text_input.h index 4ac7cd5ac..d7b32def6 100644 --- a/applications/gui/modules/text_input.h +++ b/applications/gui/modules/text_input.h @@ -1,44 +1,59 @@ +/** + * @file text_input.h + * GUI: TextInput keybord view module API + */ + #pragma once + #include #ifdef __cplusplus extern "C" { #endif -/* Text input anonymous structure */ +/** Text input anonymous structure */ typedef struct TextInput TextInput; typedef void (*TextInputCallback)(void* context); -/** Allocate and initialize text input +/** Allocate and initialize text input + * * This text input is used to enter string - * @return TextInput instance + * + * @return TextInput instance */ TextInput* text_input_alloc(); /** Deinitialize and free text input - * @param text_input - TextInput instance + * + * @param text_input TextInput instance */ void text_input_free(TextInput* text_input); -/** Clean text input view - * Note: this function does not free memory - * @param text_input - Text input instance +/** Clean text input view Note: this function does not free memory + * + * @param text_input Text input instance */ void text_input_clean(TextInput* text_input); /** Get text input view - * @param text_input - TextInput instance - * @return View instance that can be used for embedding + * + * @param text_input TextInput instance + * + * @return View instance that can be used for embedding */ View* text_input_get_view(TextInput* text_input); /** Set text input result callback - * @param text_input - TextInput instance - * @param callback - callback fn - * @param callback_context - callback context - * @param text_buffer - pointer to YOUR text buffer, that we going to modify - * @param text_buffer_size - YOUR text buffer size in bytes. Max string length will be text_buffer_size - 1. - * @param clear_default_text - clear text from text_buffer on first OK event + * + * @param text_input TextInput instance + * @param callback callback fn + * @param callback_context callback context + * @param text_buffer pointer to YOUR text buffer, that we going + * to modify + * @param text_buffer_size YOUR text buffer size in bytes. Max string + * length will be text_buffer_size-1. + * @param clear_default_text clear text from text_buffer on first OK + * event */ void text_input_set_result_callback( TextInput* text_input, @@ -49,8 +64,9 @@ void text_input_set_result_callback( bool clear_default_text); /** Set text input header text - * @param text_input - TextInput instance - * @param text - text to be shown + * + * @param text_input TextInput instance + * @param text text to be shown */ void text_input_set_header_text(TextInput* text_input, const char* text); diff --git a/applications/gui/modules/variable-item-list.h b/applications/gui/modules/variable-item-list.h index a70ded391..e1e3cbf72 100755 --- a/applications/gui/modules/variable-item-list.h +++ b/applications/gui/modules/variable-item-list.h @@ -1,4 +1,10 @@ +/** + * @file variable-item-list.h + * GUI: VariableItemList view module API + */ + #pragma once + #include #ifdef __cplusplus @@ -11,29 +17,40 @@ typedef void (*VariableItemChangeCallback)(VariableItem* item); typedef void (*VariableItemListEnterCallback)(void* context, uint32_t index); /** Allocate and initialize VariableItemList - * @return VariableItemList* + * + * @return VariableItemList* */ VariableItemList* variable_item_list_alloc(); /** Deinitialize and free VariableItemList - * @param variable_item_list VariableItemList instance + * + * @param variable_item_list VariableItemList instance */ void variable_item_list_free(VariableItemList* variable_item_list); /** Clear all elements from list - * @param variable_item_list VariableItemList instance + * + * @param variable_item_list VariableItemList instance */ void variable_item_list_clean(VariableItemList* variable_item_list); +/** Get VariableItemList View instance + * + * @param variable_item_list VariableItemList instance + * + * @return View instance + */ View* variable_item_list_get_view(VariableItemList* variable_item_list); /** Add item to VariableItemList - * @param variable_item_list VariableItemList instance - * @param label item name - * @param values_count item values count - * @param change_callback called on value change in gui - * @param context item context - * @return VariableItem* item instance + * + * @param variable_item_list VariableItemList instance + * @param label item name + * @param values_count item values count + * @param change_callback called on value change in gui + * @param context item context + * + * @return VariableItem* item instance */ VariableItem* variable_item_list_add( VariableItemList* variable_item_list, @@ -43,9 +60,10 @@ VariableItem* variable_item_list_add( void* context); /** Set enter callback - * @param variable_item_list VariableItemList instance - * @param calback VariableItemListEnterCallback instance - * @param context pointer to context + * + * @param variable_item_list VariableItemList instance + * @param callback VariableItemListEnterCallback instance + * @param context pointer to context */ void variable_item_list_set_enter_callback( VariableItemList* variable_item_list, @@ -53,29 +71,35 @@ void variable_item_list_set_enter_callback( void* context); /** Set item current selected index - * @param item VariableItem* instance - * @param current_value_index + * + * @param item VariableItem* instance + * @param current_value_index The current value index */ void variable_item_set_current_value_index(VariableItem* item, uint8_t current_value_index); /** Set item current selected text - * @param item VariableItem* instance - * @param current_value_text + * + * @param item VariableItem* instance + * @param current_value_text The current value text */ void variable_item_set_current_value_text(VariableItem* item, const char* current_value_text); /** Get item current selected index - * @param item VariableItem* instance - * @return uint8_t current selected index + * + * @param item VariableItem* instance + * + * @return uint8_t current selected index */ uint8_t variable_item_get_current_value_index(VariableItem* item); /** Get item context - * @param item VariableItem* instance - * @return void* item context + * + * @param item VariableItem* instance + * + * @return void* item context */ void* variable_item_get_context(VariableItem* item); #ifdef __cplusplus } -#endif \ No newline at end of file +#endif diff --git a/applications/gui/modules/widget.h b/applications/gui/modules/widget.h index 9a335bce6..09177c577 100755 --- a/applications/gui/modules/widget.h +++ b/applications/gui/modules/widget.h @@ -1,38 +1,51 @@ +/** + * @file widget.h + * GUI: Widget view module API + */ + #pragma once + #include "widget_elements/widget_element_i.h" typedef struct Widget Widget; typedef struct WidgetElement WidgetElement; /** Allocate Widget that holds Widget Elements - * @return Widget instance + * + * @return Widget instance */ Widget* widget_alloc(); /** Free Widget - * @note this function free allocated Widget Elements - * @param widget Widget instance + * @note this function free allocated Widget Elements + * + * @param widget Widget instance */ void widget_free(Widget* widget); /** Clear Widget - * @param widget Widget instance + * + * @param widget Widget instance */ void widget_clear(Widget* widget); /** Get Widget view - * @param widget Widget instance - * @return View instance + * + * @param widget Widget instance + * + * @return View instance */ View* widget_get_view(Widget* widget); /** Add Multi String Element - * @param widget Widget instance - * @param x - x coordinate - * @param y - y coordinate - * @param horizontal - Align instance - * @param vertical - Align instance - * @param font Font instance + * + * @param widget Widget instance + * @param x x coordinate + * @param y y coordinate + * @param horizontal Align instance + * @param vertical Align instance + * @param font Font instance + * @param[in] text The text */ void widget_add_string_multiline_element( Widget* widget, @@ -44,12 +57,14 @@ void widget_add_string_multiline_element( const char* text); /** Add String Element - * @param widget Widget instance - * @param x - x coordinate - * @param y - y coordinate - * @param horizontal - Align instance - * @param vertical - Align instance - * @param font Font instance + * + * @param widget Widget instance + * @param x x coordinate + * @param y y coordinate + * @param horizontal Align instance + * @param vertical Align instance + * @param font Font instance + * @param[in] text The text */ void widget_add_string_element( Widget* widget, @@ -61,11 +76,12 @@ void widget_add_string_element( const char* text); /** Add Button Element - * @param widget Widget instance - * @param button_type GuiButtonType instance - * @param text text on allocated button - * @param callback ButtonCallback instance - * @param context pointer to context + * + * @param widget Widget instance + * @param button_type GuiButtonType instance + * @param text text on allocated button + * @param callback ButtonCallback instance + * @param context pointer to context */ void widget_add_button_element( Widget* widget, @@ -75,20 +91,22 @@ void widget_add_button_element( void* context); /** Add Icon Element - * @param widget Widget instance - * @param x top left x coordinate - * @param y top left y coordinate - * @param icon Icon instance + * + * @param widget Widget instance + * @param x top left x coordinate + * @param y top left y coordinate + * @param icon Icon instance */ void widget_add_icon_element(Widget* widget, uint8_t x, uint8_t y, const Icon* icon); /** Add Frame Element - * @param widget Widget instance - * @param x top left x coordinate - * @param y top left y coordinate - * @param width frame width - * @param height frame height - * @param radius frame radius + * + * @param widget Widget instance + * @param x top left x coordinate + * @param y top left y coordinate + * @param width frame width + * @param height frame height + * @param radius frame radius */ void widget_add_frame_element( Widget* widget, diff --git a/applications/gui/modules/widget_elements/widget_element_i.h b/applications/gui/modules/widget_elements/widget_element_i.h index 2930eb1cf..bbc58ff9a 100755 --- a/applications/gui/modules/widget_elements/widget_element_i.h +++ b/applications/gui/modules/widget_elements/widget_element_i.h @@ -1,3 +1,8 @@ +/** + * @file widget_element_i.h + * GUI: internal Widget Element API + */ + #pragma once #include #include @@ -29,7 +34,7 @@ struct WidgetElement { Widget* parent; }; -/* Create multi string element */ +/** Create multi string element */ WidgetElement* widget_element_string_multiline_create( uint8_t x, uint8_t y, @@ -38,7 +43,7 @@ WidgetElement* widget_element_string_multiline_create( Font font, const char* text); -/* Create string element */ +/** Create string element */ WidgetElement* widget_element_string_create( uint8_t x, uint8_t y, @@ -47,20 +52,20 @@ WidgetElement* widget_element_string_create( Font font, const char* text); -/* Create button element */ +/** Create button element */ WidgetElement* widget_element_button_create( GuiButtonType button_type, const char* text, ButtonCallback callback, void* context); -/* Create icon element */ +/** Create icon element */ WidgetElement* widget_element_icon_create(uint8_t x, uint8_t y, const Icon* icon); -/* Create frame element */ +/** Create frame element */ WidgetElement* widget_element_frame_create( uint8_t x, uint8_t y, uint8_t width, uint8_t height, - uint8_t radius); \ No newline at end of file + uint8_t radius); diff --git a/applications/gui/scene_manager.h b/applications/gui/scene_manager.h index 0318b1cd7..53f8d7758 100755 --- a/applications/gui/scene_manager.h +++ b/applications/gui/scene_manager.h @@ -1,14 +1,18 @@ +/** + * @file scene_manager.h + * GUI: SceneManager API + */ + #pragma once +#include +#include + #ifdef __cplusplus extern "C" { #endif -#include -#include - -/** Scene Manager events type - */ +/** Scene Manager events type */ typedef enum { SceneManagerEventTypeCustom, SceneManagerEventTypeBack, @@ -44,86 +48,110 @@ typedef struct { typedef struct SceneManager SceneManager; /** Set Scene state - * @param scene_manager SceneManager instance - * @param scene_id Scene ID - * @param state Scene new state + * + * @param scene_manager SceneManager instance + * @param scene_id Scene ID + * @param state Scene new state */ void scene_manager_set_scene_state(SceneManager* scene_manager, uint32_t scene_id, uint32_t state); /** Get Scene state - * @param scene_manager SceneManager instance - * @param scene_id Scene ID - * @return Scene state + * + * @param scene_manager SceneManager instance + * @param scene_id Scene ID + * + * @return Scene state */ uint32_t scene_manager_get_scene_state(SceneManager* scene_manager, uint32_t scene_id); /** Scene Manager allocation and configuration + * * Scene Manager allocates all scenes internally - * @param app_scene_handlers SceneManagerHandlers instance - * @param context context to be set on Scene handlers calls - * @return SceneManager instance + * + * @param app_scene_handlers SceneManagerHandlers instance + * @param context context to be set on Scene handlers calls + * + * @return SceneManager instance */ SceneManager* scene_manager_alloc(const SceneManagerHandlers* app_scene_handlers, void* context); /** Free Scene Manager with allocated Scenes - * @param scene_manager SceneManager instance + * + * @param scene_manager SceneManager instance */ void scene_manager_free(SceneManager* scene_manager); /** Custom event handler + * * Calls Scene event handler with Custom event parameter - * @param scene_manager SceneManager instance - * @param custom_event Custom event code - * @return true if event was consumed, false otherwise + * + * @param scene_manager SceneManager instance + * @param custom_event Custom event code + * + * @return true if event was consumed, false otherwise */ bool scene_manager_handle_custom_event(SceneManager* scene_manager, uint32_t custom_event); /** Back event handler + * * Calls Scene event handler with Back event parameter - * @param scene_manager SceneManager instance - * @return true if event was consumed, false otherwise + * + * @param scene_manager SceneManager instance + * + * @return true if event was consumed, false otherwise */ bool scene_manager_handle_back_event(SceneManager* scene_manager); /** Tick event handler + * * Calls Scene event handler with Tick event parameter - * @param scene_manager SceneManager instance - * @return true if event was consumed, false otherwise + * + * @param scene_manager SceneManager instance + * @return true if event was consumed, false otherwise */ void scene_manager_handle_tick_event(SceneManager* scene_manager); /** Add and run next Scene - * @param scene_manager SceneManager instance - * @param next_scene_id next Scene ID + * + * @param scene_manager SceneManager instance + * @param next_scene_id next Scene ID */ void scene_manager_next_scene(SceneManager* scene_manager, uint32_t next_scene_id); /** Run previous Scene - * @param scene_manager SceneManager instance - * @return true if previous scene was found, false otherwise + * + * @param scene_manager SceneManager instance + * + * @return true if previous scene was found, false otherwise */ bool scene_manager_previous_scene(SceneManager* scene_manager); /** Search previous Scene - * @param scene_manager SceneManager instance - * @param scene_id Scene ID - * @return true if previous scene was found, false otherwise + * + * @param scene_manager SceneManager instance + * @param scene_id Scene ID + * + * @return true if previous scene was found, false otherwise */ bool scene_manager_has_previous_scene(SceneManager* scene_manager, uint32_t scene_id); /** Search and switch to previous Scene - * @param scene_manager SceneManager instance - * @param scene_id Scene ID - * @return true if previous scene was found, false otherwise + * + * @param scene_manager SceneManager instance + * @param scene_id Scene ID + * + * @return true if previous scene was found, false otherwise */ bool scene_manager_search_and_switch_to_previous_scene( SceneManager* scene_manager, uint32_t scene_id); /** Clear Scene stack and switch to another Scene - * @param scene_manager SceneManager instance - * @param scene_id Scene ID - * @return true if previous scene was found, false otherwise + * + * @param scene_manager SceneManager instance + * @param scene_id Scene ID + * + * @return true if previous scene was found, false otherwise */ bool scene_manager_search_and_switch_to_another_scene( SceneManager* scene_manager, diff --git a/applications/gui/scene_manager_i.h b/applications/gui/scene_manager_i.h index bb05d5478..fca798d12 100755 --- a/applications/gui/scene_manager_i.h +++ b/applications/gui/scene_manager_i.h @@ -1,3 +1,8 @@ +/** + * @file scene_manager_i.h + * GUI: internal SceneManager API + */ + #pragma once #include "scene_manager.h" diff --git a/applications/gui/view.h b/applications/gui/view.h index 33fdd187f..5b4bf3609 100644 --- a/applications/gui/view.h +++ b/applications/gui/view.h @@ -1,3 +1,8 @@ +/** + * @file view.h + * GUI: View API + */ + #pragma once #include @@ -27,57 +32,57 @@ typedef enum { typedef struct View View; /** View Draw callback - * @param canvas, pointer to canvas - * @param view_model, pointer to context - * @warning called from GUI thread + * @param canvas, pointer to canvas + * @param view_model, pointer to context + * @warning called from GUI thread */ typedef void (*ViewDrawCallback)(Canvas* canvas, void* model); /** View Input callback - * @param event, pointer to input event data - * @param context, pointer to context - * @return true if event handled, false if event ignored - * @warning called from GUI thread + * @param event, pointer to input event data + * @param context, pointer to context + * @return true if event handled, false if event ignored + * @warning called from GUI thread */ typedef bool (*ViewInputCallback)(InputEvent* event, void* context); /** View Custom callback - * @param event, number of custom event - * @param context, pointer to context - * @return true if event handled, false if event ignored + * @param event, number of custom event + * @param context, pointer to context + * @return true if event handled, false if event ignored */ typedef bool (*ViewCustomCallback)(uint32_t event, void* context); /** View navigation callback - * @param context, pointer to context - * @return next view id - * @warning called from GUI thread + * @param context, pointer to context + * @return next view id + * @warning called from GUI thread */ typedef uint32_t (*ViewNavigationCallback)(void* context); /** View callback - * @param context, pointer to context - * @warning called from GUI thread + * @param context, pointer to context + * @warning called from GUI thread */ typedef void (*ViewCallback)(void* context); -/** View Update Callback - * Called upon model change, need to be propagated to GUI throw ViewPort update - * @param view, pointer to view - * @param context, pointer to context - * @warning called from GUI thread +/** View Update Callback Called upon model change, need to be propagated to GUI + * throw ViewPort update + * @param view, pointer to view + * @param context, pointer to context + * @warning called from GUI thread */ typedef void (*ViewUpdateCallback)(View* view, void* context); /** View model types */ typedef enum { - /* Model is not allocated */ + /** Model is not allocated */ ViewModelTypeNone, - /* Model consist of atomic types and/or partial update is not critical for rendering. + /** Model consist of atomic types and/or partial update is not critical for rendering. * Lock free. */ ViewModelTypeLockFree, - /* Model access is guarded with mutex. + /** Model access is guarded with mutex. * Locking gui thread. */ ViewModelTypeLocking, @@ -89,98 +94,115 @@ typedef enum { View* view_alloc(); /** Free View - * @param View instance + * + * @param view instance */ void view_free(View* view); /** Tie IconAnimation with View - * @param view, View instance - * @param icon_animation, IconAnimation instance + * + * @param view View instance + * @param icon_animation IconAnimation instance */ void view_tie_icon_animation(View* view, IconAnimation* icon_animation); /** Set View Draw callback - * @param view, View instance - * @param callback, draw callback + * + * @param view View instance + * @param callback draw callback */ void view_set_draw_callback(View* view, ViewDrawCallback callback); /** Set View Input callback - * @param view, View instance - * @param callback, input callback + * + * @param view View instance + * @param callback input callback */ void view_set_input_callback(View* view, ViewInputCallback callback); /** Set View Custom callback - * @param view, View instance - * @param callback, input callback + * + * @param view View instance + * @param callback input callback */ void view_set_custom_callback(View* view, ViewCustomCallback callback); /** Set Navigation Previous callback - * @param view, View instance - * @param callback, input callback + * + * @param view View instance + * @param callback input callback */ void view_set_previous_callback(View* view, ViewNavigationCallback callback); /** Set Enter callback - * @param view, View instance - * @param callback, callback + * + * @param view View instance + * @param callback callback */ void view_set_enter_callback(View* view, ViewCallback callback); /** Set Exit callback - * @param view, View instance - * @param callback, callback + * + * @param view View instance + * @param callback callback */ void view_set_exit_callback(View* view, ViewCallback callback); /** Set Update callback - * @param view, View instance - * @param callback, callback + * + * @param view View instance + * @param callback callback */ void view_set_update_callback(View* view, ViewUpdateCallback callback); /** Set View Draw callback - * @param view, View instance - * @param context, context for callbacks + * + * @param view View instance + * @param context context for callbacks */ void view_set_update_callback_context(View* view, void* context); /** Set View Draw callback - * @param view, View instance - * @param context, context for callbacks + * + * @param view View instance + * @param context context for callbacks */ void view_set_context(View* view, void* context); /** Set View Orientation - * @param view, View instance - * @param orientation, either vertical or horizontal + * + * @param view View instance + * @param orientation either vertical or horizontal */ void view_set_orientation(View* view, ViewOrientation orientation); /** Allocate view model. - * @param view, View instance - * @param type, View Model Type - * @param size, size + * + * @param view View instance + * @param type View Model Type + * @param size size */ void view_allocate_model(View* view, ViewModelType type, size_t size); /** Free view model data memory. - * @param view, View instance + * + * @param view View instance */ void view_free_model(View* view); /** Get view model data - * @param view, View instance - * @return pointer to model data - * @warning Don't forget to commit model changes + * + * @param view View instance + * + * @return pointer to model data + * @warning Don't forget to commit model changes */ void* view_get_model(View* view); /** Commit view model - * @param view, View instance - * @param update, true if you want to emit view update, false otherwise + * + * @param view View instance + * @param update true if you want to emit view update, false otherwise */ void view_commit_model(View* view, bool update); @@ -196,11 +218,13 @@ void view_commit_model(View* view, bool update); view_commit_model(view, update); \ } #else -/** - * With clause for view model - * @param view, View instance pointer - * @param function_body a (){} lambda declaration, executed within you parent function context - * @return true if you want to emit view update, false otherwise +/** With clause for view model + * + * @param view View instance pointer + * @param function_body a (){} lambda declaration, executed within you + * parent function context + * + * @return true if you want to emit view update, false otherwise */ #define with_view_model(view, function_body) \ { \ diff --git a/applications/gui/view_dispatcher.h b/applications/gui/view_dispatcher.h index 895c9b787..7b22cfc9c 100755 --- a/applications/gui/view_dispatcher.h +++ b/applications/gui/view_dispatcher.h @@ -1,3 +1,8 @@ +/** + * @file view_dispatcher.h + * GUI: ViewDispatcher API + */ + #pragma once #include "view.h" @@ -8,8 +13,7 @@ extern "C" { #endif -/** ViewDispatcher view_port placement - */ +/** ViewDispatcher view_port placement */ typedef enum { ViewDispatcherTypeNone, /**< Special layer for internal use only */ ViewDispatcherTypeWindow, /**< Main view_port layer, status bar is shown */ @@ -18,61 +22,70 @@ typedef enum { typedef struct ViewDispatcher ViewDispatcher; -/** Prototype for custom event callback - */ +/** Prototype for custom event callback */ typedef bool (*ViewDispatcherCustomEventCallback)(void* context, uint32_t event); -/** Prototype for navigation event callback - */ +/** Prototype for navigation event callback */ typedef bool (*ViewDispatcherNavigationEventCallback)(void* context); -/** Prototype for tick event callback - */ +/** Prototype for tick event callback */ typedef void (*ViewDispatcherTickEventCallback)(void* context); /** Allocate ViewDispatcher instance - * @return pointer to ViewDispatcher instance + * + * @return pointer to ViewDispatcher instance */ ViewDispatcher* view_dispatcher_alloc(); /** Free ViewDispatcher instance - * @param view_dispatcher pointer to ViewDispatcher + * + * @param view_dispatcher pointer to ViewDispatcher */ void view_dispatcher_free(ViewDispatcher* view_dispatcher); /** Enable queue support - * If queue enabled all input and custom events will be dispatched throw internal queue - * @param view_dispatcher ViewDispatcher instance + * + * If queue enabled all input and custom events will be dispatched throw + * internal queue + * + * @param view_dispatcher ViewDispatcher instance */ void view_dispatcher_enable_queue(ViewDispatcher* view_dispatcher); /** Send custom event - * @param view_dispatcher ViewDispatcher instance + * + * @param view_dispatcher ViewDispatcher instance + * @param[in] event The event */ void view_dispatcher_send_custom_event(ViewDispatcher* view_dispatcher, uint32_t event); /** Set custom event handler + * * Called on Custom Event, if it is not consumed by view - * @param view_dispatcher ViewDispatcher instance - * @param callback ViewDispatcherCustomEventCallback instance + * + * @param view_dispatcher ViewDispatcher instance + * @param callback ViewDispatcherCustomEventCallback instance */ void view_dispatcher_set_custom_event_callback( ViewDispatcher* view_dispatcher, ViewDispatcherCustomEventCallback callback); /** Set navigation event handler + * * Called on Input Short Back Event, if it is not consumed by view - * @param view_dispatcher ViewDispatcher instance - * @param callback ViewDispatcherNavigationEventCallback instance + * + * @param view_dispatcher ViewDispatcher instance + * @param callback ViewDispatcherNavigationEventCallback instance */ void view_dispatcher_set_navigation_event_callback( ViewDispatcher* view_dispatcher, ViewDispatcherNavigationEventCallback callback); /** Set tick event handler - * @param view_dispatcher ViewDispatcher instance - * @param callback ViewDispatcherTickEventCallback - * @param tick_period callback call period + * + * @param view_dispatcher ViewDispatcher instance + * @param callback ViewDispatcherTickEventCallback + * @param tick_period callback call period */ void view_dispatcher_set_tick_event_callback( ViewDispatcher* view_dispatcher, @@ -80,46 +93,57 @@ void view_dispatcher_set_tick_event_callback( uint32_t tick_period); /** Set event callback context - * @param view_dispatcher ViewDispatcher instance - * @param context pointer to context + * + * @param view_dispatcher ViewDispatcher instance + * @param context pointer to context */ void view_dispatcher_set_event_callback_context(ViewDispatcher* view_dispatcher, void* context); /** Run ViewDispatcher + * * Use only after queue enabled - * @param view_dispatcher ViewDispatcher instance + * + * @param view_dispatcher ViewDispatcher instance */ void view_dispatcher_run(ViewDispatcher* view_dispatcher); /** Stop ViewDispatcher + * * Use only after queue enabled - * @param view_dispatcher ViewDispatcher instance + * + * @param view_dispatcher ViewDispatcher instance */ void view_dispatcher_stop(ViewDispatcher* view_dispatcher); /** Add view to ViewDispatcher - * @param view_dispatcher, ViewDispatcher instance - * @param view_id View id to register - * @param view View instance + * + * @param view_dispatcher ViewDispatcher instance + * @param view_id View id to register + * @param view View instance */ void view_dispatcher_add_view(ViewDispatcher* view_dispatcher, uint32_t view_id, View* view); /** Remove view from ViewDispatcher - * @param view_dispatcher ViewDispatcher instance - * @param view_id View id to remove + * + * @param view_dispatcher ViewDispatcher instance + * @param view_id View id to remove */ void view_dispatcher_remove_view(ViewDispatcher* view_dispatcher, uint32_t view_id); /** Switch to View - * @param view_dispatcher ViewDispatcher instance - * @param view_id View id to register - * @warning switching may be delayed till input events complementarity reached + * + * @param view_dispatcher ViewDispatcher instance + * @param view_id View id to register + * @warning switching may be delayed till input events complementarity + * reached */ void view_dispatcher_switch_to_view(ViewDispatcher* view_dispatcher, uint32_t view_id); /** Attach ViewDispatcher to GUI - * @param view_dispatcher ViewDispatcher instance - * @param gui GUI instance to attach to + * + * @param view_dispatcher ViewDispatcher instance + * @param gui GUI instance to attach to + * @param[in] type The type */ void view_dispatcher_attach_to_gui( ViewDispatcher* view_dispatcher, diff --git a/applications/gui/view_dispatcher_i.h b/applications/gui/view_dispatcher_i.h index 60c9aa47b..ad0f08889 100644 --- a/applications/gui/view_dispatcher_i.h +++ b/applications/gui/view_dispatcher_i.h @@ -1,3 +1,8 @@ +/** + * @file view_dispatcher_i.h + * GUI: ViewDispatcher API + */ + #pragma once #include @@ -41,23 +46,23 @@ typedef struct { }; } ViewDispatcherMessage; -/* ViewPort Draw Callback */ +/** ViewPort Draw Callback */ void view_dispatcher_draw_callback(Canvas* canvas, void* context); -/* ViewPort Input Callback */ +/** ViewPort Input Callback */ void view_dispatcher_input_callback(InputEvent* event, void* context); -/* Input handler */ +/** Input handler */ void view_dispatcher_handle_input(ViewDispatcher* view_dispatcher, InputEvent* event); -/* Tick handler */ +/** Tick handler */ void view_dispatcher_handle_tick_event(ViewDispatcher* view_dispatcher); -/* Custom event handler */ +/** Custom event handler */ void view_dispatcher_handle_custom_event(ViewDispatcher* view_dispatcher, uint32_t event); -/* Set current view, dispatches view enter and exit */ +/** Set current view, dispatches view enter and exit */ void view_dispatcher_set_current_view(ViewDispatcher* view_dispatcher, View* view); -/* ViewDispatcher update event */ +/** ViewDispatcher update event */ void view_dispatcher_update(View* view, void* context); diff --git a/applications/gui/view_i.h b/applications/gui/view_i.h index 2d2d779fe..21b374d52 100644 --- a/applications/gui/view_i.h +++ b/applications/gui/view_i.h @@ -1,3 +1,8 @@ +/** + * @file view_i.h + * GUI: internal View API + */ + #pragma once #include "view.h" @@ -26,26 +31,26 @@ struct View { void* context; }; -/* IconAnimation tie callback */ +/** IconAnimation tie callback */ void view_icon_animation_callback(IconAnimation* instance, void* context); -/* Unlock model */ +/** Unlock model */ void view_unlock_model(View* view); -/* Draw Callback for View dispatcher */ +/** Draw Callback for View dispatcher */ void view_draw(View* view, Canvas* canvas); -/* Input Callback for View dispatcher */ +/** Input Callback for View dispatcher */ bool view_input(View* view, InputEvent* event); -/* Custom Callback for View dispatcher */ +/** Custom Callback for View dispatcher */ bool view_custom(View* view, uint32_t event); -/* Previous Callback for View dispatcher */ +/** Previous Callback for View dispatcher */ uint32_t view_previous(View* view); -/* Enter Callback for View dispatcher */ +/** Enter Callback for View dispatcher */ void view_enter(View* view); -/* Exit Callback for View dispatcher */ +/** Exit Callback for View dispatcher */ void view_exit(View* view); diff --git a/applications/gui/view_port.h b/applications/gui/view_port.h index 24c133395..96f2798e2 100644 --- a/applications/gui/view_port.h +++ b/applications/gui/view_port.h @@ -1,3 +1,8 @@ +/** + * @file view_port.h + * GUI: ViewPort API + */ + #pragma once #include @@ -15,50 +20,65 @@ typedef enum { } ViewPortOrientation; /** ViewPort Draw callback - * @warning called from GUI thread + * @warning called from GUI thread */ typedef void (*ViewPortDrawCallback)(Canvas* canvas, void* context); /** ViewPort Input callback - * @warning called from GUI thread + * @warning called from GUI thread */ typedef void (*ViewPortInputCallback)(InputEvent* event, void* context); /** ViewPort allocator + * * always returns view_port or stops system if not enough memory. + * + * @return ViewPort instance */ ViewPort* view_port_alloc(); /** ViewPort deallocator + * * Ensure that view_port was unregistered in GUI system before use. + * + * @param view_port ViewPort instance */ void view_port_free(ViewPort* view_port); /** Set view_port width. + * * Will be used to limit canvas drawing area and autolayout feature. - * @param width - wanted width, 0 - auto. + * + * @param view_port ViewPort instance + * @param width wanted width, 0 - auto. */ void view_port_set_width(ViewPort* view_port, uint8_t width); uint8_t view_port_get_width(ViewPort* view_port); /** Set view_port height. + * * Will be used to limit canvas drawing area and autolayout feature. - * @param height - wanted height, 0 - auto. + * + * @param view_port ViewPort instance + * @param height wanted height, 0 - auto. */ void view_port_set_height(ViewPort* view_port, uint8_t height); uint8_t view_port_get_height(ViewPort* view_port); /** Enable or disable view_port rendering. - * @param view_port - ViewPort instance - * @param enabled - * @warning automatically dispatches update event + * + * @param view_port ViewPort instance + * @param enabled Indicates if enabled + * @warning automatically dispatches update event */ void view_port_enabled_set(ViewPort* view_port, bool enabled); bool view_port_is_enabled(ViewPort* view_port); /** ViewPort event callbacks - * @param callback - appropriate callback function - * @param context - context to pass to callback + * + * @param view_port ViewPort instance + * @param callback appropriate callback function + * @param context context to pass to callback */ void view_port_draw_callback_set(ViewPort* view_port, ViewPortDrawCallback callback, void* context); void view_port_input_callback_set( @@ -67,12 +87,17 @@ void view_port_input_callback_set( void* context); /** Emit update signal to GUI system. + * * Rendering will happen later after GUI system process signal. + * + * @param view_port ViewPort instance */ void view_port_update(ViewPort* view_port); /** Set ViewPort orientation. - * @param orientation, display orientation, horizontal or vertical. + * + * @param view_port ViewPort instance + * @param orientation display orientation, horizontal or vertical. */ void view_port_set_orientation(ViewPort* view_port, ViewPortOrientation orientation); ViewPortOrientation view_port_get_orientation(const ViewPort* view_port); diff --git a/applications/gui/view_port_i.h b/applications/gui/view_port_i.h index 55a9aa009..90f48ac93 100644 --- a/applications/gui/view_port_i.h +++ b/applications/gui/view_port_i.h @@ -1,3 +1,8 @@ +/** + * @file view_port_i.h + * GUI: internal ViewPort API + */ + #pragma once #include "gui_i.h" @@ -18,23 +23,29 @@ struct ViewPort { void* input_callback_context; }; -/* - * Set GUI reference. +/** Set GUI reference. + * * To be used by GUI, called upon view_port tree insert - * @param gui - gui instance pointer. + * + * @param view_port ViewPort instance + * @param gui gui instance pointer */ void view_port_gui_set(ViewPort* view_port, Gui* gui); -/* - * Process draw call. Calls draw callback. +/** Process draw call. Calls draw callback. + * * To be used by GUI, called on tree redraw. - * @param canvas - canvas to draw at. + * + * @param view_port ViewPort instance + * @param canvas canvas to draw at */ void view_port_draw(ViewPort* view_port, Canvas* canvas); -/* - * Process input. Calls input callbac +/** Process input. Calls input callback. + * * To be used by GUI, called on input dispatch. - * @param event - pointer to input event. + * + * @param view_port ViewPort instance + * @param event pointer to input event */ void view_port_input(ViewPort* view_port, InputEvent* event); diff --git a/applications/input/input.h b/applications/input/input.h index fd6da95d9..d848b1c6b 100644 --- a/applications/input/input.h +++ b/applications/input/input.h @@ -1,19 +1,24 @@ +/** + * @file input.h + * Input: main API + */ + #pragma once #include -/* Input Types +/** Input Types * Some of them are physical events and some logical */ typedef enum { - InputTypePress, /* Press event, emitted after debounce */ - InputTypeRelease, /* Release event, emitted after debounce */ - InputTypeShort, /* Short event, emitted after InputTypeRelease done withing INPUT_LONG_PRESS interval */ - InputTypeLong, /* Long event, emmited after INPUT_LONG_PRESS interval, asynchronouse to InputTypeRelease */ - InputTypeRepeat, /* Repeat event, emmited with INPUT_REPEATE_PRESS period after InputTypeLong event */ + InputTypePress, /**< Press event, emitted after debounce */ + InputTypeRelease, /**< Release event, emitted after debounce */ + InputTypeShort, /**< Short event, emitted after InputTypeRelease done withing INPUT_LONG_PRESS interval */ + InputTypeLong, /**< Long event, emmited after INPUT_LONG_PRESS interval, asynchronouse to InputTypeRelease */ + InputTypeRepeat, /**< Repeat event, emmited with INPUT_REPEATE_PRESS period after InputTypeLong event */ } InputType; -/* Input Event, dispatches with PubSub */ +/** Input Event, dispatches with PubSub */ typedef struct { uint32_t sequence; InputKey key; diff --git a/applications/input/input_i.h b/applications/input/input_i.h index d0cdfa760..db314dad2 100644 --- a/applications/input/input_i.h +++ b/applications/input/input_i.h @@ -1,3 +1,8 @@ +/** + * @file input_i.h + * Input: internal API + */ + #pragma once #include "input.h" @@ -16,7 +21,7 @@ #define INPUT_LONG_PRESS_COUNTS 2 #define INPUT_THREAD_FLAG_ISR 0x00000001 -/* Input pin state */ +/** Input pin state */ typedef struct { const InputPin* pin; // State @@ -27,7 +32,7 @@ typedef struct { volatile uint32_t counter; } InputPinState; -/* Input state */ +/** Input state */ typedef struct { osThreadId_t thread; PubSub event_pubsub; @@ -36,8 +41,8 @@ typedef struct { volatile uint32_t counter; } Input; -/* Input press timer callback */ +/** Input press timer callback */ void input_press_timer_callback(void* arg); -/* Input interrupt handler */ +/** Input interrupt handler */ void input_isr(void* _ctx); diff --git a/core/furi-hal/api-interrupt-mgr.h b/core/furi-hal/api-interrupt-mgr.h index 81245cb9d..0a9c9d8c9 100644 --- a/core/furi-hal/api-interrupt-mgr.h +++ b/core/furi-hal/api-interrupt-mgr.h @@ -1,3 +1,8 @@ +/** + * @file api-interrupt-mgr.h + * Furi: interrupt API + */ + #pragma once #include @@ -23,45 +28,45 @@ typedef struct { bool ready; } InterruptCallbackItem; -/** - * Init interrupt - * @return true on succsessful initialization, false otherwise +/** Init interrupt + * + * @return true on succsessful initialization, false otherwise */ bool api_interrupt_init(); -/** - * Add interrupt - * @param callback InterruptCallback - * @param type InterruptType - * @param context context for callback +/** Add interrupt + * + * @param callback InterruptCallback + * @param type InterruptType + * @param context context for callback */ void api_interrupt_add(InterruptCallback callback, InterruptType type, void* context); -/** - * Remove interrupt - * @param callback InterruptCallback - * @param type InterruptType +/** Remove interrupt + * + * @param callback InterruptCallback + * @param type InterruptType */ void api_interrupt_remove(InterruptCallback callback, InterruptType type); -/** - * Enable interrupt - * @param callback InterruptCallback - * @param type InterruptType +/** Enable interrupt + * + * @param callback InterruptCallback + * @param type InterruptType */ void api_interrupt_enable(InterruptCallback callback, InterruptType type); -/** - * Disable interrupt - * @param callback InterruptCallback - * @param type InterruptType +/** Disable interrupt + * + * @param callback InterruptCallback + * @param type InterruptType */ void api_interrupt_disable(InterruptCallback callback, InterruptType type); -/** - * Call interrupt - * @param type InterruptType - * @param hw pointer to hardware peripheral +/** Call interrupt + * + * @param type InterruptType + * @param hw pointer to hardware peripheral */ void api_interrupt_call(InterruptType type, void* hw); diff --git a/core/furi/memmgr.c b/core/furi/memmgr.c index a79cc5020..12146247f 100644 --- a/core/furi/memmgr.c +++ b/core/furi/memmgr.c @@ -68,6 +68,12 @@ size_t memmgr_get_minimum_free_heap(void) { return xPortGetMinimumEverFreeHeapSize(); } +void* furi_alloc(size_t size) { + void* p = malloc(size); + furi_check(p); + return memset(p, 0, size); +} + void* __wrap__malloc_r(struct _reent* r, size_t size) { void* pointer = malloc(size); return pointer; diff --git a/core/furi/memmgr.h b/core/furi/memmgr.h index 98e7c1d8f..7c8a3fe90 100644 --- a/core/furi/memmgr.h +++ b/core/furi/memmgr.h @@ -1,3 +1,8 @@ +/** + * @file memmgr.h + * Furi: memory managment API and glue + */ + #pragma once #include @@ -12,14 +17,27 @@ extern "C" { // define for test case "link against furi memmgr" #define FURI_MEMMGR_GUARD 1 +/** Get free heap size + * + * @return free heap size in bytes + */ size_t memmgr_get_free_heap(void); + +/** Get heap watermark + * + * @return minimum heap in bytes + */ size_t memmgr_get_minimum_free_heap(void); -inline static void* furi_alloc(size_t size) { - void* p = malloc(size); - furi_check(p); - return memset(p, 0, size); -} +/** Allocate memory from heap + * + * @note performs memset with 0, will crash system if not enough memory + * + * @param[in] size bytes to allocate + * + * @return pointer to allocated memory + */ +void* furi_alloc(size_t size); #ifdef __cplusplus } diff --git a/core/furi/memmgr_heap.h b/core/furi/memmgr_heap.h index cbb8fa89c..04dced06a 100644 --- a/core/furi/memmgr_heap.h +++ b/core/furi/memmgr_heap.h @@ -1,3 +1,8 @@ +/** + * @file memmgr_heap.h + * Furi: heap memory managment API and allocator + */ + #pragma once #include @@ -10,28 +15,32 @@ extern "C" { #define MEMMGR_HEAP_UNKNOWN 0xFFFFFFFF /** Memmgr heap enable thread allocation tracking - * @param thread_id - thread id to track + * + * @param thread_id - thread id to track */ void memmgr_heap_enable_thread_trace(osThreadId_t thread_id); /** Memmgr heap disable thread allocation tracking - * @param thread_id - thread id to track + * + * @param thread_id - thread id to track */ void memmgr_heap_disable_thread_trace(osThreadId_t thread_id); /** Memmgr heap get allocatred thread memory - * @param thread_id - thread id to track - * @return bytes allocated right now + * + * @param thread_id - thread id to track + * + * @return bytes allocated right now */ size_t memmgr_heap_get_thread_memory(osThreadId_t thread_id); /** Memmgr heap get the max contiguous block size on the heap - * @return size_t max contiguous block size + * + * @return size_t max contiguous block size */ size_t memmgr_heap_get_max_free_block(); -/** - * Print the address and size of all free blocks to stdout +/** Print the address and size of all free blocks to stdout */ void memmgr_heap_printf_free_blocks(); diff --git a/core/furi/record.h b/core/furi/record.h index bc90a25df..d5d92deb6 100644 --- a/core/furi/record.h +++ b/core/furi/record.h @@ -1,3 +1,8 @@ +/** + * @file record.h + * Furi: record API + */ + #pragma once #include @@ -6,36 +11,45 @@ extern "C" { #endif -/** Initialize record storage - * For internal use only. +/** Initialize record storage For internal use only. */ void furi_record_init(); /** Create record - * @param name - record name - * @param data - data pointer - * @note Thread safe. Create and destroy must be executed from the same thread. + * + * @param name record name + * @param data data pointer + * @note Thread safe. Create and destroy must be executed from the same + * thread. */ void furi_record_create(const char* name, void* data); /** Destroy record - * @param name - record name - * @return true if successful, false if still have holders or thread is not owner. - * @note Thread safe. Create and destroy must be executed from the same thread. + * + * @param name record name + * + * @return true if successful, false if still have holders or thread is not + * owner. + * @note Thread safe. Create and destroy must be executed from the same + * thread. */ bool furi_record_destroy(const char* name); /** Open record - * @param name - record name - * @return pointer to the record - * @note Thread safe. Open and close must be executed from the same thread. - * Suspends caller thread till record appear + * + * @param name record name + * + * @return pointer to the record + * @note Thread safe. Open and close must be executed from the same + * thread. Suspends caller thread till record appear */ void* furi_record_open(const char* name); /** Close record - * @param name - record name - * @note Thread safe. Open and close must be executed from the same thread. + * + * @param name record name + * @note Thread safe. Open and close must be executed from the same + * thread. */ void furi_record_close(const char* name); diff --git a/core/furi/stdglue.h b/core/furi/stdglue.h index a13c994d4..c83a443ee 100644 --- a/core/furi/stdglue.h +++ b/core/furi/stdglue.h @@ -1,3 +1,8 @@ +/** + * @file stdglue.h + * Furi: stdlibc glue + */ + #pragma once #include @@ -7,31 +12,31 @@ extern "C" { #endif -/** - * Write callback - * @param _cookie - pointer to cookie (see stdio gnu extension) - * @param data - pointer to data - * @param size - data size - * @warnign your handler must consume everything +/** Write callback + * @param _cookie pointer to cookie (see stdio gnu extension) + * @param data pointer to data + * @param size data size @warnign your handler must consume everything */ typedef void (*FuriStdglueWriteCallback)(void* _cookie, const char* data, size_t size); /** Initialized std library glue code */ void furi_stdglue_init(); -/** - * Set global STDOUT callback - * @param callback - callback or NULL to clear - * @return true on success, otherwise fail - * @warning function is thread aware, use this API from the same thread +/** Set global STDOUT callback + * + * @param callback callback or NULL to clear + * + * @return true on success, otherwise fail + * @warning function is thread aware, use this API from the same thread */ bool furi_stdglue_set_global_stdout_callback(FuriStdglueWriteCallback callback); -/** - * Set STDOUT callback for your thread - * @param callback - callback or NULL to clear - * @return true on success, otherwise fail - * @warning function is thread aware, use this API from the same thread +/** Set STDOUT callback for your thread + * + * @param callback callback or NULL to clear + * + * @return true on success, otherwise fail + * @warning function is thread aware, use this API from the same thread */ bool furi_stdglue_set_thread_stdout_callback(FuriStdglueWriteCallback callback); diff --git a/core/furi/thread.h b/core/furi/thread.h index a47362654..503425179 100644 --- a/core/furi/thread.h +++ b/core/furi/thread.h @@ -1,3 +1,8 @@ +/** + * @file thread.h + * Furi: Furi Thread API + */ + #pragma once #include @@ -18,109 +23,130 @@ typedef enum { /** FuriThread anonymous structure */ typedef struct FuriThread FuriThread; -/** FuriThreadCallback - * Your callback to run in new thread - * @warning don't use osThreadExit +/** FuriThreadCallback Your callback to run in new thread + * @warning never use osThreadExit in FuriThread */ typedef int32_t (*FuriThreadCallback)(void* context); -/** FuriThread state change calback - * called upon thread state change - * @param state - new thread state - * @param context - callback context +/** FuriThread state change calback called upon thread state change + * @param state new thread state + * @param context callback context */ typedef void (*FuriThreadStateCallback)(FuriThreadState state, void* context); /** Allocate FuriThread - * @return FuriThread instance + * + * @return FuriThread instance */ FuriThread* furi_thread_alloc(); /** Release FuriThread - * @param thread - FuriThread instance + * + * @param thread FuriThread instance */ void furi_thread_free(FuriThread* thread); /** Set FuriThread name - * @param thread - FuriThread instance - * @param name - string + * + * @param thread FuriThread instance + * @param name string */ void furi_thread_set_name(FuriThread* thread, const char* name); /** Set FuriThread stack size - * @param thread - FuriThread instance - * @param stack_size - stack size in bytes + * + * @param thread FuriThread instance + * @param stack_size stack size in bytes */ void furi_thread_set_stack_size(FuriThread* thread, size_t stack_size); /** Set FuriThread callback - * @param thread - FuriThread instance - * @param callback - FuriThreadCallback, called upon thread run + * + * @param thread FuriThread instance + * @param callback FuriThreadCallback, called upon thread run */ void furi_thread_set_callback(FuriThread* thread, FuriThreadCallback callback); /** Set FuriThread context - * @param thread - FuriThread instance - * @param context - pointer to context for thread callback + * + * @param thread FuriThread instance + * @param context pointer to context for thread callback */ void furi_thread_set_context(FuriThread* thread, void* context); /** Set FuriThread state change callback - * @param thread - FuriThread instance - * @param callack - state change callback + * + * @param thread FuriThread instance + * @param callback state change callback */ void furi_thread_set_state_callback(FuriThread* thread, FuriThreadStateCallback callback); /** Set FuriThread state change context - * @param thread - FuriThread instance - * @param context - pointer to context + * + * @param thread FuriThread instance + * @param context pointer to context */ void furi_thread_set_state_context(FuriThread* thread, void* context); /** Get FuriThread state - * @param thread - FuriThread instance - * @return thread state from FuriThreadState + * + * @param thread FuriThread instance + * + * @return thread state from FuriThreadState */ FuriThreadState furi_thread_get_state(FuriThread* thread); /** Start FuriThread - * @param thread - FuriThread instance - * @return true on success + * + * @param thread FuriThread instance + * + * @return true on success */ bool furi_thread_start(FuriThread* thread); /** Treminate FuriThread - * @param thread - FuriThread instance - * @return osStatus_t - * @warning terminating statefull thread is dangerous - * use only if you know what you doing + * + * @param thread FuriThread instance + * + * @return osStatus_t + * @warning terminating statefull thread is dangerous use only if you know + * what you doing */ osStatus_t furi_thread_terminate(FuriThread* thread); /** Join FuriThread - * @param thread - FuriThread instance - * @return osStatus_t + * + * @param thread FuriThread instance + * + * @return osStatus_t */ osStatus_t furi_thread_join(FuriThread* thread); /** Get CMSIS Thread ID - * @param thread - FuriThread instance - * @return osThreadId_t or NULL + * + * @param thread FuriThread instance + * + * @return osThreadId_t or NULL */ osThreadId_t furi_thread_get_thread_id(FuriThread* thread); /** Enable heap tracing - * @param thread - FuriThread instance + * + * @param thread FuriThread instance */ void furi_thread_enable_heap_trace(FuriThread* thread); /** Disable heap tracing - * @param thread - FuriThread instance + * + * @param thread FuriThread instance */ void furi_thread_disable_heap_trace(FuriThread* thread); /** Get thread heap size - * @param thread - FuriThread instance + * + * @param thread FuriThread instance + * + * @return size in bytes */ size_t furi_thread_get_heap_size(FuriThread* thread); diff --git a/documentation/Doxyfile b/documentation/Doxyfile new file mode 100644 index 000000000..08760acf4 --- /dev/null +++ b/documentation/Doxyfile @@ -0,0 +1,2608 @@ +# Doxyfile 1.9.2 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "FlipperZero Firmware" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = documentation + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# 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 +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = applications \ + core \ + lib/irda \ + lib/subghz \ + lib/toolbox \ + lib/onewire \ + firmware/targets/furi-hal-include + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# 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 +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATOR_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see https://docs.mathjax.org/en/v2.7-latest/tex.html +# #tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /