NaturalDocs::StatusMessage

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

Summary

NaturalDocs::StatusMessage	A package to handle status message updates.
Variables
message	The message to display.
total	The number of items to work through.
completed	The number of items completed.
lastMessageTime	The time the last message was posted.
Constants
TIME_BETWEEN_UPDATES	The number of seconds that should occur between updates.
Functions
Start	Starts the status message.
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.

The number of seconds that should occur between updates.

sub Start #( message,
total )

Starts the status message.

message	The message to post.
total	The number of items that are going to be worked through.

sub CompletedItem

Should be called every time an item is completed.