NaturalDocs::StatusMessage

A package to handle status message updates.  Automatically handles NaturalDocs::Settings->IsQuiet().

Summary
NaturalDocs::StatusMessageA package to handle status message updates.
Variables
messageThe message to display.
totalThe number of items to work through.
completedThe number of items completed.
lastMessageTimeThe time the last message was posted.
Constants
TIME_BETWEEN_UPDATESThe number of seconds that should occur between updates.
Functions
StartStarts the status message.
CompletedItemShould be called every time an item is completed.

Variables

message

my $message

The message to display.

total

my $total

The number of items to work through.

completed

my $completed

The number of items completed.

lastMessageTime

my $lastMessageTime

The time the last message was posted.

Constants

TIME_BETWEEN_UPDATES

The number of seconds that should occur between updates.

Functions

Start

sub Start #(message,
total)

Starts the status message.

Parameters

messageThe message to post.
totalThe number of items that are going to be worked through.

CompletedItem

sub CompletedItem

Should be called every time an item is completed.

my $message
The message to display.
my $total
The number of items to work through.
my $completed
The number of items completed.
my $lastMessageTime
The time the last message was posted.
sub Start #(message,
total)
Starts the status message.
sub CompletedItem
Should be called every time an item is completed.
sub IsQuiet
Returns whether the script should be run in quiet mode or not.
Close