Skip to content

Commit

Permalink
add mainpage to doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
UmbrellaLeaf5 committed May 9, 2024
1 parent 6b7cfa2 commit 484a471
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions mainpage.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/*! @mainpage Locus No Pilotus: Trajectory Calculator
*
* @section brief Brief
* Project of four first grade MIPT DAFE/RSE students (for engineering practical
* work in the second semester) in Qt C++.
*
* @section description Description
* In this project, we are developing an application that calculates the
* trajectory of a flying delivery robot that collects valuable cargo from
* control points: **Targets**. On its way, it may encounter high mountains that
* it cannot fly over: **Hills**; or elliptical territories that are impossible
* to visit due to climate conditions: **TrappyCircles**. Also, through some
* control points, the robot is simply unable to move, as the cargo may not be
* ready for transportation at that time, these are **TrappyLines**.
*
* The robot's trajectory is calculated using several mathematical algorithms:
* [...]. The graphical interface for constructing the trajectory was created
* using [Qt](#used-libs-and-packages) and
* [QCustomPlot](#used-libs-and-packages).
*
* In the application, you can add objects using window forms, interact with the
* trajectory calculation plot using the mouse cursor, create and open files in
* ```.json``` format with a specific style for this application. Editing
* objects can also be done with cursors or using a special dynamic input field
* with tables, opened in a separate window mode or embedded in the main one.
*
*/

0 comments on commit 484a471

Please sign in to comment.