Author: marvin
Date: Mon Jul 23 23:10:49 2012
New Revision: 1364833
URL: http://svn.apache.org/viewvc?rev=1364833&view=rev
Log:
LUCY-242 Update Obj documentation.
Modified:
lucy/trunk/core/Clownfish/Obj.cfh
lucy/trunk/perl/buildlib/Lucy/Build/Binding/Object.pm
Modified: lucy/trunk/core/Clownfish/Obj.cfh
URL:
http://svn.apache.org/viewvc/lucy/trunk/core/Clownfish/Obj.cfh?rev=1364833&r1=1364832&r2=1364833&view=diff
==============================================================================
--- lucy/trunk/core/Clownfish/Obj.cfh (original)
+++ lucy/trunk/core/Clownfish/Obj.cfh Mon Jul 23 23:10:49 2012
@@ -16,7 +16,7 @@
parcel Lucy;
-/** Base class for all Lucy objects.
+/** Base class for all objects.
*/
public class Clownfish::Obj {
Modified: lucy/trunk/perl/buildlib/Lucy/Build/Binding/Object.pm
URL:
http://svn.apache.org/viewvc/lucy/trunk/perl/buildlib/Lucy/Build/Binding/Object.pm?rev=1364833&r1=1364832&r2=1364833&view=diff
==============================================================================
--- lucy/trunk/perl/buildlib/Lucy/Build/Binding/Object.pm (original)
+++ lucy/trunk/perl/buildlib/Lucy/Build/Binding/Object.pm Mon Jul 23 23:10:49
2012
@@ -570,9 +570,10 @@ sub bind_obj {
}
END_SYNOPSIS
my $description = <<'END_DESCRIPTION';
-All objects in the Lucy:: hierarchy descend from
-Clownfish::Obj. All classes are implemented as blessed scalar
-references, with the scalar storing a pointer to a C struct.
+Clownfish::Obj is the base class of the Clownfish object hierarchy.
+
+From the standpoint of a Perl programmer, all classes are implemented as
+blessed scalar references, with the scalar storing a pointer to a C struct.
=head2 Subclassing
@@ -597,8 +598,7 @@ Caveats:
=item *
Inside-out aficionados will have noted that the "cached scalar id" stratagem
-recommended above isn't compatible with ithreads -- but Lucy doesn't
-support ithreads anyway, so it doesn't matter.
+recommended above isn't compatible with ithreads.
=item *
@@ -622,7 +622,7 @@ Takes no arguments; if any are supplied,
=head2 DESTROY
-All Lucy classes implement a DESTROY method; if you override it in a
+All Clownfish classes implement a DESTROY method; if you override it in a
subclass, you must call C<< $self->SUPER::DESTROY >> to avoid leaking memory.
END_DESCRIPTION
$pod_spec->set_synopsis($synopsis);
