Commit 16675994 authored by Stefan Tauner's avatar Stefan Tauner
Browse files

fiji_scripts: minor documentation refinements

parent 7245318b
...@@ -769,7 +769,7 @@ FILE_PATTERNS = *.pm *.pl ...@@ -769,7 +769,7 @@ FILE_PATTERNS = *.pm *.pl
# be searched for input files as well. # be searched for input files as well.
# The default value is: NO. # The default value is: NO.
RECURSIVE = NO RECURSIVE = yes
# The EXCLUDE tag can be used to specify files and/or directories that should be # The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a # excluded from the INPUT source files. This way you can easily exclude a
......
## @file [FIJI.pm] ## @file
## @class [FIJI] ## @class FIJI
# #
# Various constants used in the FIJI packages. # Various constants used in the FIJI packages.
package FIJI; package FIJI;
use strict;
use warnings;
# Architecture from http://www.perlmonks.org/?node_id=1072731 # Architecture from http://www.perlmonks.org/?node_id=1072731
# Fields: # Fields:
......
## @file [Connection.pm] ## @file
## @class [FIJI::Connection] ## @class FIJI::Connection
# #
# Instances of this class represent a single serial connection to a FIJI-compatible DUT. # Instances of this class represent a single serial connection to a FIJI-compatible DUT.
# Besides handling all communication-related functions they are also responsible for generating and interpreting the respective payloads. # Besides handling all communication-related functions they are also responsible for generating and interpreting the respective payloads.
...@@ -8,6 +8,9 @@ ...@@ -8,6 +8,9 @@
# The implementation relies on AnySerialPort.pm to be cross-platform-compatible. # The implementation relies on AnySerialPort.pm to be cross-platform-compatible.
package FIJI::Connection; package FIJI::Connection;
use strict;
use warnings;
use Switch; use Switch;
use Log::Log4perl qw(get_logger); use Log::Log4perl qw(get_logger);
......
## @file [Settings.pm] ## @file
## @class [FIJI::Settings] ## @class FIJI::Settings
# #
# Contains helper functions to deal with FIJI Settings files. # Contains helper functions to deal with FIJI Settings files.
package FIJI::Settings; package FIJI::Settings;
use strict;
use warnings;
use Log::Log4perl qw(get_logger); use Log::Log4perl qw(get_logger);
use Scalar::Util "looks_like_number"; use Scalar::Util "looks_like_number";
use Config::Simple; use Config::Simple;
......
## @file [fiji_download.pl] ## @file
use strict; use strict;
use warnings; use warnings;
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment