You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucy.apache.org by nw...@apache.org on 2013/07/20 22:37:58 UTC
[lucy-commits] [2/6] git commit: refs/heads/cfc-pod - Documentation for CFCPerlClass
Documentation for CFCPerlClass
Project: http://git-wip-us.apache.org/repos/asf/lucy/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucy/commit/dfb40d2d
Tree: http://git-wip-us.apache.org/repos/asf/lucy/tree/dfb40d2d
Diff: http://git-wip-us.apache.org/repos/asf/lucy/diff/dfb40d2d
Branch: refs/heads/cfc-pod
Commit: dfb40d2d17edc211b2ea78a58e5f7cf50d4a7a30
Parents: a1e5103
Author: Nick Wellnhofer <we...@aevum.de>
Authored: Sat Jul 20 20:04:11 2013 +0200
Committer: Nick Wellnhofer <we...@aevum.de>
Committed: Sat Jul 20 20:11:34 2013 +0200
----------------------------------------------------------------------
.../perl/buildlib/Clownfish/CFC/Build/Binding.pm | 14 ++++++++++++++
clownfish/compiler/src/CFCPerlClass.h | 9 +++++++--
2 files changed, 21 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucy/blob/dfb40d2d/clownfish/compiler/perl/buildlib/Clownfish/CFC/Build/Binding.pm
----------------------------------------------------------------------
diff --git a/clownfish/compiler/perl/buildlib/Clownfish/CFC/Build/Binding.pm b/clownfish/compiler/perl/buildlib/Clownfish/CFC/Build/Binding.pm
index 0819b4b..207f528 100644
--- a/clownfish/compiler/perl/buildlib/Clownfish/CFC/Build/Binding.pm
+++ b/clownfish/compiler/perl/buildlib/Clownfish/CFC/Build/Binding.pm
@@ -25,12 +25,26 @@ sub bind_perlclass {
class_from_c('CFCPerlClass', 'Clownfish::CFC::Binding::Perl::Class');
my @exposed = qw(
+ Add_To_Registry
Bind_Constructor
Bind_Method
Exclude_Constructor
Exclude_Method
+ Method_Bindings
+ Constructor_Bindings
+ Create_Pod
+ Get_Client
+ Get_Class_Name
+ Append_Xs
+ Get_Xs_Code
Set_Pod_Spec
+ Get_Pod_Spec
);
+ # TODO: Generate docs for functions
+ #my @exposed_functions = qw(
+ # singleton
+ # clear_registry
+ #);
my $pod_spec = Clownfish::CFC::Binding::Perl::Pod->new;
$pod_spec->add_constructor( alias => 'new' );
http://git-wip-us.apache.org/repos/asf/lucy/blob/dfb40d2d/clownfish/compiler/src/CFCPerlClass.h
----------------------------------------------------------------------
diff --git a/clownfish/compiler/src/CFCPerlClass.h b/clownfish/compiler/src/CFCPerlClass.h
index 89fd1fe..cbbbb24 100644
--- a/clownfish/compiler/src/CFCPerlClass.h
+++ b/clownfish/compiler/src/CFCPerlClass.h
@@ -29,8 +29,7 @@ struct CFCPerlPod;
struct CFCPerlMethod;
struct CFCPerlConstructor;
-/** Clownfish::CFC::Binding::Perl::Class - Generate Perl binding code for a
- * Clownfish::CFC::Model::Class.
+/** Generate Perl binding code for a Clownfish::CFC::Model::Class.
*/
/**
@@ -90,6 +89,8 @@ CFCPerlClass_bind_constructor(CFCPerlClass *self, const char *alias,
const char *initializer);
/** Block the automatic generation of a method binding.
+ *
+ * @param method The Clownfish name for the method.
*/
void
CFCPerlClass_exclude_method(CFCPerlClass *self, const char *method);
@@ -128,6 +129,8 @@ const char*
CFCPerlClass_get_class_name(CFCPerlClass *self);
/** Concatenate verbatim XS code.
+ *
+ * @param xs A string containing the XS code.
*/
void
CFCPerlClass_append_xs(CFCPerlClass *self, const char *xs);
@@ -139,6 +142,8 @@ CFCPerlClass_get_xs_code(CFCPerlClass *self);
/** Supply a specification which will cause POD to be generated for this class
* binding.
+ *
+ * @param method A Clownfish::CFC::Binding::Perl::Pod object.
*/
void
CFCPerlClass_set_pod_spec(CFCPerlClass *self, struct CFCPerlPod *pod_spec);