[lucy-commits] [09/11] git commit: refs/heads/master - Update Clownfish docs for _IMP.

[ma...@apache.org]

Update Clownfish docs for _IMP.

Change the documentation for naming conventions of method
implementations.


Project: http://git-wip-us.apache.org/repos/asf/lucy/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucy/commit/a329bd54
Tree: http://git-wip-us.apache.org/repos/asf/lucy/tree/a329bd54
Diff: http://git-wip-us.apache.org/repos/asf/lucy/diff/a329bd54

Branch: refs/heads/master
Commit: a329bd5450ec65bc13f102a3d902e1894a14c19f
Parents: 7c4db76
Author: Marvin Humphrey <ma...@rectangular.com>
Authored: Wed Aug 7 11:48:01 2013 -0700
Committer: Marvin Humphrey <ma...@rectangular.com>
Committed: Mon Aug 12 13:40:47 2013 -0700

----------------------------------------------------------------------
 clownfish/runtime/perl/lib/Clownfish.pod | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucy/blob/a329bd54/clownfish/runtime/perl/lib/Clownfish.pod
----------------------------------------------------------------------
diff --git a/clownfish/runtime/perl/lib/Clownfish.pod b/clownfish/runtime/perl/lib/Clownfish.pod
index 6b8507d..60609c2 100644
--- a/clownfish/runtime/perl/lib/Clownfish.pod
+++ b/clownfish/runtime/perl/lib/Clownfish.pod
@@ -383,7 +383,7 @@ For every method, an inline wrapper for dynamic dispatch is defined in
 the generated C header with the name
 C<{Parcel_Nick}_{Class_Nick}_{Method_Name}>. Additionally, an
 implementing function is declared with the name
-C<{parcel_nick}_{Class_Nick}_{method_name}>. The Clownfish compiler also
+C<{Parcel_Nick}_{Class_Nick}_{Method_Name}_IMP>. The Clownfish compiler also
 generates a typedef for the method's function pointer type named
 C<{Parcel_Nick}_{Class_Nick}_{Method_Name}_t>. Wrappers and typedefs are
 created for all subclasses whether they override a method or not.
@@ -407,7 +407,8 @@ This will generate:
 
     /* Declaration of implementing function */
     void
-    pfind_VisGraph_add_node(pfind_VisibilityGraph *self, pfind_Node *node);
+    Pfind_VisGraph_Add_Node_IMP(pfind_VisibilityGraph *self,
+                                pfind_Node *node);
 
     /* Declaration of function pointer type */
     typedef void
@@ -422,7 +423,7 @@ implementation will look like:
     #include "Pathfinder/Graph/VisibilityGraph.h"
 
     void
-    VisGraph_add_node(VisibilityGraph *self, Node *node) {
+    VisGraph_Add_Node_IMP(VisibilityGraph *self, Node *node) {
         /* Implementation */
     }
 
@@ -603,7 +604,7 @@ Example:
     /* Implementation */
 
     void
-    Path_destroy(Path *self) {
+    Path_Destroy_IMP(Path *self) {
         DECREF(self->nodes);
         SUPER_DESTROY(self, PATH);
     }