Skip to content

Commit

Permalink
Item9986: minor doc improvements
Browse files Browse the repository at this point in the history
git-svn-id: http://svn.foswiki.org/trunk@10209 0b4bb1d4-4e5a-0410-9cc4-b2b747904278
  • Loading branch information
CrawfordCurrie authored and CrawfordCurrie committed Dec 6, 2010
1 parent 0333d4a commit 7f59daa
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions core/lib/Foswiki/Meta.pm
Expand Up @@ -392,23 +392,25 @@ sub new {
This constructor will load (or otherwise fetch) the meta-data for a
named web/topic.
* =$rev= - revision to load. If undef, 0, '' or > max available rev, will
load the latest rev.
load the latest rev. If the revision is in range but does not exist,
then will return an unloaded meta object (getLoadedRev() will be undef)
This method is functionally identical to:
<verbatim>
$this = Foswiki::Meta->new( $session, $web, $topic );
$this->loadVersion( $rev );
</verbatim>
WARNING: see notes on revision numbers under =getLoadedRev=
WARNING: see notes on revision numbers under =getLoadedRev=.
---++ ObjectMethod load($rev) -> $metaObject
Load an unloaded meta-data object with a given version of the data.
Once loaded, the object is locked to that revision.
* =$rev= - revision to load. If undef, 0, '' or > max available rev, will
load the latest rev.
load the latest rev. If the revision is in range but does not exist,
then will return an unloaded meta object (getLoadedRev() will be undef)
WARNING: see notes on revision numbers under =getLoadedRev=
Expand Down Expand Up @@ -936,7 +938,8 @@ with a different rev (verified by an ASSERT)
See =getLoadedRev= to determine what revision is currently being viewed.
* =$rev= - revision to load. If undef, 0, '' or > max available rev, will
load the latest rev.
load the latest rev. If the revision is in range but does not exist,
then will return an unloaded meta object (getLoadedRev() will be undef)
Returns the version identifier for the loaded revision.
Expand Down Expand Up @@ -3465,6 +3468,7 @@ TODO: can we move this code into Foswiki::Serialise ?

sub getEmbeddedStoreForm {
my $this = shift;

ASSERT( $this->{_web} && $this->{_topic}, 'this is not a topic object' )
if DEBUG;
$this->{_text} ||= '';
Expand Down Expand Up @@ -3565,6 +3569,7 @@ Note: line endings must be normalised to \n *before* calling this method.

sub setEmbeddedStoreForm {
my ( $this, $text ) = @_;

ASSERT( $this->{_web} && $this->{_topic}, 'this is not a topic object' )
if DEBUG;

Expand Down

0 comments on commit 7f59daa

Please sign in to comment.