Skip to content

Commit

Permalink
try to add description to doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
UmbrellaLeaf5 committed May 9, 2024
1 parent 061aec9 commit 2f42ef9
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
16 changes: 16 additions & 0 deletions .extra/doxygen/description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Locus No Pilotus: Trajectory Calculator

**Project of four first grade MIPT DAFE/RSE students (for engineering practical work in the second semester) in Qt C++**

## 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](https://www.qt.io/) and [QCustomPlot](https://www.qcustomplot.com/).

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.

*We strongly recommend that you install our application using the instructions below and try it out!*
2 changes: 1 addition & 1 deletion .extra/doxygen/doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -1171,7 +1171,7 @@ FILTER_SOURCE_PATTERNS =
# (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 =
USE_MDFILE_AS_MAINPAGE = .extra/doxygen/description.md

# The Fortran standard specifies that for fixed formatted Fortran code all
# characters from position 72 are to be considered as comment. A common
Expand Down

0 comments on commit 2f42ef9

Please sign in to comment.