From f919c20cbd6bf51bc3fd47f411fe80f07c057cd1 Mon Sep 17 00:00:00 2001 From: vmagnin Date: Fri, 28 Jun 2024 17:52:28 +0200 Subject: [PATCH] More FORD comments --- example/la_folia.f90 | 8 ++++---- src/MIDI_file_class.f90 | 4 +++- src/utilities.f90 | 1 + 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/example/la_folia.f90 b/example/la_folia.f90 index 247f215..d0927be 100644 --- a/example/la_folia.f90 +++ b/example/la_folia.f90 @@ -4,8 +4,8 @@ ! Vincent Magnin, 2024-06-05 ! Last modifications: 2024-06-23 -! An example on the classical Portuguese/Spanish theme of La Folia -! https://en.wikipedia.org/wiki/Folia +!> An example on the classical Portuguese/Spanish theme of La Folia +!> https://en.wikipedia.org/wiki/Folia program la_folia use MIDI_file_class use music @@ -125,8 +125,8 @@ program la_folia contains - ! Receives a string with an encoded chords, and returns its fundamental, - ! the type of chord and its encoded value + !> Receives a string with an encoded chords, and returns its fundamental, + !> the type of chord and its encoded value subroutine analyze(string, note, chord_type, note_value) character(*), intent(in) :: string character(3), intent(out) :: note, chord_type, note_value diff --git a/src/MIDI_file_class.f90 b/src/MIDI_file_class.f90 index 12ea1ad..0a005a8 100644 --- a/src/MIDI_file_class.f90 +++ b/src/MIDI_file_class.f90 @@ -4,6 +4,7 @@ ! Vincent Magnin ! Last modifications: 2024-06-22 +!> Contains the main class you need to create a MIDI file. module MIDI_file_class use, intrinsic :: iso_fortran_env, only: int8, int16, int32, error_unit use utilities, only: checked_int8, checked_int16, checked_int32 @@ -18,6 +19,7 @@ module MIDI_file_class integer, parameter :: ON = 144 ! z'90' integer, parameter :: OFF = 128 ! z'80' + !> The main class you need to create a MIDI file. type MIDI_file character(len=:), private, allocatable :: filename ! Output unit and file status: @@ -233,7 +235,7 @@ subroutine delta_time(self, ticks) call self%write_variable_length_quantity(checked_int32(ticks)) end subroutine - + !> Closes the MIDI file. subroutine close(self) class(MIDI_file), intent(inout) :: self diff --git a/src/utilities.f90 b/src/utilities.f90 index 0088078..a0e9a7b 100644 --- a/src/utilities.f90 +++ b/src/utilities.f90 @@ -4,6 +4,7 @@ ! Vincent Magnin ! Last modifications: 2024-06-14 +!> Functions to check the bounds of int8, int16, int32 values. module utilities use, intrinsic :: iso_fortran_env, only: int8, int16, int32, error_unit