Skip to content

Commit 56ae2df

Browse files
committed
Add doc for task
1 parent 81a725b commit 56ae2df

1 file changed

Lines changed: 19 additions & 6 deletions

File tree

fortran/solver/src/task.f90

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,31 @@
11
module task_mod
22
implicit none
33
private
4+
5+
!> @brief task to solve
46
type :: task_t
5-
character(len=:), allocatable :: API_URL
6-
character(len=:), allocatable :: API_ID
7-
character(len=:), allocatable :: name
8-
integer :: n_rooms = 0
9-
integer :: max_length = 0
10-
integer :: kind = 0
7+
character(len=:), allocatable :: API_URL !< URL to access tasks
8+
character(len=:), allocatable :: API_ID !< ID to access tasks
9+
character(len=:), allocatable :: name !< task name
10+
integer :: n_rooms = 0 !< number of rooms in task
11+
integer :: max_length = 0 !< longest possible plan
12+
integer :: kind = 0 !< type of task; lightning - 1, post-ligthning - 2
1113
contains
1214
procedure :: init
1315
end type task_t
16+
1417
public :: task_t
1518
contains
19+
20+
!>
21+
!> @brief initialise task_t
22+
!>
23+
!> @param[in,out] task - task_t object
24+
!> @param[in] name - name of task
25+
!>
26+
!> @author foxtran
27+
!> @date Sep 8, 2025
28+
!>
1629
subroutine init(task, name)
1730
class(task_t), intent(inout) :: task
1831
character(len=*) :: name

0 commit comments

Comments
 (0)