[svn:parrot] r48512 - trunk/src/pmc

[mikehh at svn.parrot.org]

Author: mikehh
Date: Sun Aug 15 12:20:40 2010
New Revision: 48512
URL: https://trac.parrot.org/parrot/changeset/48512

Log:
add documentation to pass pmc_docs.t

Modified:
   trunk/src/pmc/bignum.pmc

Modified: trunk/src/pmc/bignum.pmc
==============================================================================
--- trunk/src/pmc/bignum.pmc	Sun Aug 15 10:53:46 2010	(r48511)
+++ trunk/src/pmc/bignum.pmc	Sun Aug 15 12:20:40 2010	(r48512)
@@ -148,6 +148,15 @@
 =item C<static void bignum_set_default_prec(PARROT_INTERP, PMC *self, INTVAL
 prec)>
 
+All the above functions are local to the bignum pmc and are there to provide
+interface functions to The GNU MP Bignum Library (GMP)
+
+If GMP is not available, at present these functions will throw a NYI exception.
+
+(It would be appreciated if maintainers/implementors could improve the
+ documentation here at some stage. possibly adding documentation for
+ individual functions - at least the less obvious ones.)
+
 =cut
 
 */