Skip to content

Commit 491139d

Browse files
committed
Add doc in step
1 parent 8de767d commit 491139d

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

fortran/solver/src/step.f90

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,27 @@
11
module step_mod
22
implicit none
33
private
4+
5+
!> @brief step in plan
46
type :: step_t
5-
integer(1) :: room_out = -1
6-
integer(1) :: door_out = -1
7-
integer(1) :: room_in = -1
7+
integer(1) :: room_out = -1 !< starting room
8+
integer(1) :: door_out = -1 !< starting door
9+
integer(1) :: room_in = -1 !< entered room
810
contains
911
procedure :: show
1012
end type step_t
13+
1114
public :: step_t
1215
contains
16+
17+
!>
18+
!> @brief prints structure of step_t to stdout
19+
!>
20+
!> @param[in] step - step_t object
21+
!>
22+
!> @author foxtran
23+
!> @date Sep 8, 2025
24+
!>
1325
subroutine show(step)
1426
class(step_t), intent(in) :: step
1527
write(6, '(I3," ",I0," ",I3)') step%room_out, step%door_out, step%room_in

0 commit comments

Comments
 (0)