mirrors/flipperzero-firmware
1
Fork 0
mirror of https://github.com/flipperdevices/flipperzero-firmware.git synced 2025-12-12 04:41:26 +04:00
Code Issues Activity

Documentation: update and cleanup (#3934)

Browse Source 
* Developers Docs editing

* Logo underline removed

The underline has been removed when hovering over the logo.

* proofread docs

* application -> app in several files

---------

Co-authored-by: knrn64 <25254561+knrn64@users.noreply.github.com>
Co-authored-by: あく <alleteam@gmail.com>
This commit is contained in:
Ruslan Nadyrshin
2024-10-08 15:27:16 +04:00
committed by GitHub
parent 0eaad8bf64
commit 41c35cd59e
33 changed files with 247 additions and 228 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
documentation/doxygen/index.dox
View File

@@ -1,26 +1,26 @@
/**
@mainpage Overview
Welcome to the Flipper Zero Firmware Developer Documentation!
Welcome to the Flipper Developer Documentation!
This documentation is intended for developers who want to modify the firmware of the Flipper Zero.
This documentation is intended for developers interested in modifying the Flipper Zero firmware, creating Apps and JavaScript programs, or working on external hardware modules for the device.
If you are looking for the user manual, please visit the [User Documentation](https://docs.flipperzero.one/) instead.
If you are looking for the user manual, please visit the [User Documentation](https://docs.flipper.net/) instead.
The documentation is divided into several sections, with all of them accessible from the sidebar on the left:
The documentation is divided into several sections. All of them are accessible from the sidebar on the left:
- @ref applications - Writing applications for Flipper Zero
- @ref system - Understanding the firmware's internals
- @ref file_formats - Saving and loading data to and from files
- @ref dev_tools - Hardware and software tools for all kinds of programming
- @ref expansion - Additional modules to expand Flipper's consciousness
- @ref misc - Various useful pieces of information
- @ref js - JS-based scripting engine documentation
- @ref dev_tools — Hardware and software tools for all kinds of programming
- @ref system — Understanding the firmware's internals
- @ref applications — Developing apps for Flipper Zero
- @ref js — JS-based scripting engine
- @ref expansion — Additional modules to expand Flipper's consciousness
- @ref file_formats — Saving and loading data to and from files
- @ref misc — Various useful pieces of information
Aside from the manually-written documentation files, there's also a few automatically-generated ones at the bottom of the sidebar:
These sections are all manually written. There are also a few automatically generated ones at the bottom of the sidebar:
- [Data Structures](annotated.html) - Every data structure in a list
- [Files](files.html) - Source file tree with easy navigation
- [Data Structures](annotated.html) — Every data structure in a list
- [Files](files.html) — Source file tree with easy navigation
These are generated from the source code and are useful for quickly finding the source code or API documentation for a particular function or data structure.
*/