Changeset 74fc22a for perlglue.xs

Timestamp:

Jan 10, 2008, 3:48:00 PM (16 years ago)

Author:

Nelson Elhage <nelhage@mit.edu>

Branches:

master, barnowl_perlaim, debian, release-1.10, release-1.4, release-1.5, release-1.6, release-1.7, release-1.8, release-1.9

Children:

b68342b

Parents:

635881c

Message:

Document (nearly) every public function in the BarnOwl:: namespace

File:

• perlglue.xs (modified) (1 diff)

perlglue.xs

@@ -13 +13 @@
 #define SV_IS_CODEREF(sv) (SvROK((sv)) && SvTYPE(SvRV((sv))) == SVt_PVCV)
 
-MODULE = BarnOwl                PACKAGE = BarnOwl               
+MODULE = BarnOwl                PACKAGE = BarnOwl
+
+        /*************************************************************
+         * NOTE
+         *************************************************************
+         * These functions, when they are intended to be user-visible,
+         * are document in perlwrap.pm. If you add functions to this
+         * file, add the appropriate documentation there!
+         *
+         * If the function is simple enough, we simply define its
+         * entire functionality here in XS. If, however, it needs
+         * complex argument processing or something, we define a
+         * simple version here that takes arguments in as flat a
+         * manner as possible, to simplify the XS code, with a name
+         * with a trailing `_internal', and write a perl wrapper in
+         * perlwrap.pm that munges the arguments as appropriate and
+         * calls the internal version.
+         */
 
 char *