Changeset 1041 for trunk/core/lib/Foswiki/AccessControlException.pm

Timestamp:

11/28/08 13:33:03 (3 years ago)

Author:

CrawfordCurrie

Message:

Item175: Added Foswiki::Time to published APIs and deprecated the duplicates in Foswiki::Func, cleaned up versioning of published APIs and added VERSION to each. Item295: changed =pod to =begin TML

File:

• trunk/core/lib/Foswiki/AccessControlException.pm (modified) (4 diffs)

trunk/core/lib/Foswiki/AccessControlException.pm

@@ -1 +1 @@
 # See bottom of file for license and copyright information
-=pod TML
+
+=begin TML
 
 ---+ package Foswiki::AccessControlException
@@ -18 +19 @@
 user is not logged in) or reported (if they are and just don't have access).
 
+API version $Date$ (revision $Rev$)
+
+*Since* _date_ indicates where functions or parameters have been added since
+the baseline of the API (TWiki release 4.2.3). The _date_ indicates the
+earliest date of a Foswiki release that will support that function or
+parameter.
+
+*Deprecated* _date_ indicates where a function or parameters has been
+[[http://en.wikipedia.org/wiki/Deprecation][deprecated]]. Deprecated
+functions will still work, though they should
+_not_ be called in new plugins and should be replaced in older plugins
+as soon as possible. Deprecated parameters are simply ignored in Foswiki
+releases after _date_.
+
+*Until* _date_ indicates where a function or parameter has been removed.
+The _date_ indicates the latest date at which Foswiki releases still supported
+the function or parameter.
+
 =cut
+
+# THIS PACKAGE IS PART OF THE PUBLISHED API USED BY EXTENSION AUTHORS.
+# DO NOT CHANGE THE EXISTING APIS (well thought out extensions are OK)
+# AND ENSURE ALL POD DOCUMENTATION IS COMPLETE AND ACCURATE.
 
 package Foswiki::AccessControlException;
@@ -25 +48 @@
 use strict;
 
-=pod
+our $VERSION = '$Rev$';
+
+=begin TML
 
 ---+ ClassMethod new($mode, $user, $web, $topic, $reason)
@@ -52 +77 @@
 }
 
-=pod
+=begin TML
 
 ---++ ObjectMethod stringify() -> $string