oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixed some POD formatting.

Browse source
This commit is contained in:
JT Smith 2002-12-17 00:39:48 +00:00
parent 50948d36d6
commit 005e2eb8aa
28 changed files with 148 additions and 159 deletions
Download patch file Download diff file Expand all files Collapse all files

16
lib/WebGUI/Session.pm
View file

@ -35,6 +35,14 @@ tie %session, 'Tie::CPHash';
Package WebGUI::Session
=head1 DESCRIPTION
This package is the heart and lifeblood of WebGUI. Without it WebGUI could not exist. By using this package a package gains access to WebGUI's $session variable which contains everything WebGUI needs to know to operate.
NOTE: It is important to distinguish the difference between a WebGUI session and a user session. A user session is attached to a WebGUI session. A WebGUI session is all of the basic data the WebGUI needs to operate.
TIP: The $session variable is a case-insensitive hash. The contents of the has vary, but can be seen by adding debug=1 to the end of any WebGUI URL while logged in as an admin user.
=head1 SYNOPSIS
use WebGUI::Session;
@ -51,14 +59,6 @@ Package WebGUI::Session
WebGUI::Session::setScratch($name,$value);
WebGUI::Session::start($userId);
=head1 DESCRIPTION
This package is the heart and lifeblood of WebGUI. Without it WebGUI could not exist. By using this package a package gains access to WebGUI's $session variable which contains everything WebGUI needs to know to operate.
NOTE: It is important to distinguish the difference between a WebGUI session and a user session. A user session is attached to a WebGUI session. A WebGUI session is all of the basic data the WebGUI needs to operate.
TIP: The $session variable is a case-insensitive hash. The contents of the has vary, but can be seen by adding debug=1 to the end of any WebGUI URL while logged in as an admin user.
=head1 METHODS
These subroutines are available from this package: