harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From telli...@apache.org
Subject svn commit: r724734 [43/46] - in /harmony/standard/site: docs/externals/kernel_doc/ docs/externals/kernel_doc/html/ docs/externals/vm_doc/ docs/externals/vm_doc/html/ docs/subcomponents/classlibrary/ xdocs/subcomponents/classlibrary/
Date Tue, 09 Dec 2008 15:03:51 GMT
Added: harmony/standard/site/docs/externals/vm_doc/html/installdox
URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/installdox?rev=724734&view=auto
==============================================================================
--- harmony/standard/site/docs/externals/vm_doc/html/installdox (added)
+++ harmony/standard/site/docs/externals/vm_doc/html/installdox Tue Dec  9 07:03:45 2008
@@ -0,0 +1,117 @@
+#!/usr/bin/perl
+
+%subst = ( "doxy_tag", "");
+$quiet   = 0;
+
+if (open(F,"search.cfg"))
+{
+  $_=<F> ; s/[ \t\n]*$//g ; $subst{"_doc"} = $_;
+  $_=<F> ; s/[ \t\n]*$//g ; $subst{"_cgi"} = $_;
+}
+
+while ( @ARGV ) {
+  $_ = shift @ARGV;
+  if ( s/^-// ) {
+    if ( /^l(.*)/ ) {
+      $v = ($1 eq "") ? shift @ARGV : $1;
+      ($v =~ /\/$/) || ($v .= "/");
+      $_ = $v;
+      if ( /(.+)\@(.+)/ ) {
+        if ( exists $subst{$1} ) {
+          $subst{$1} = $2;
+        } else {
+          print STDERR "Unknown tag file $1 given with option -l\n";
+          &usage();
+        }
+      } else {
+        print STDERR "Argument $_ is invalid for option -l\n";
+        &usage();
+      }
+    }
+    elsif ( /^q/ ) {
+      $quiet = 1;
+    }
+    elsif ( /^\?|^h/ ) {
+      &usage();
+    }
+    else {
+      print STDERR "Illegal option -$_\n";
+      &usage();
+    }
+  }
+  else {
+    push (@files, $_ );
+  }
+}
+
+foreach $sub (keys %subst)
+{
+  if ( $subst{$sub} eq "" ) 
+  {
+    print STDERR "No substitute given for tag file `$sub'\n";
+    &usage();
+  }
+  elsif ( ! $quiet && $sub ne "_doc" && $sub ne "_cgi" )
+  {
+    print "Substituting $subst{$sub} for each occurence of tag file $sub\n"; 
+  }
+}
+
+if ( ! @files ) {
+  if (opendir(D,".")) {
+    foreach $file ( readdir(D) ) {
+      $match = ".html";
+      next if ( $file =~ /^\.\.?$/ );
+      ($file =~ /$match/) && (push @files, $file);
+      ($file =~ "tree.js") && (push @files, $file);
+    }
+    closedir(D);
+  }
+}
+
+if ( ! @files ) {
+  print STDERR "Warning: No input files given and none found!\n";
+}
+
+foreach $f (@files)
+{
+  if ( ! $quiet ) {
+    print "Editing: $f...\n";
+  }
+  $oldf = $f;
+  $f   .= ".bak";
+  unless (rename $oldf,$f) {
+    print STDERR "Error: cannot rename file $oldf\n";
+    exit 1;
+  }
+  if (open(F,"<$f")) {
+    unless (open(G,">$oldf")) {
+      print STDERR "Error: opening file $oldf for writing\n";
+      exit 1;
+    }
+    if ($oldf ne "tree.js") {
+      while (<F>) {
+        s/doxygen\=\"([^ \"\:\t\>\<]*)\:([^ \"\t\>\<]*)\" (href|src)=\"\2/doxygen\=\"$1:$subst{$1}\" \3=\"$subst{$1}/g;
+        print G "$_";
+      }
+    }
+    else {
+      while (<F>) {
+        s/\"([^ \"\:\t\>\<]*)\:([^ \"\t\>\<]*)\", \"\2/\"$1:$subst{$1}\" ,\"$subst{$1}/g;
+        print G "$_";
+      }
+    }
+  } 
+  else {
+    print STDERR "Warning file $f does not exist\n";
+  }
+  unlink $f;
+}
+
+sub usage {
+  print STDERR "Usage: installdox [options] [html-file [html-file ...]]\n";
+  print STDERR "Options:\n";
+  print STDERR "     -l tagfile\@linkName   tag file + URL or directory \n";
+  print STDERR "     -q                    Quiet mode\n\n";
+  exit 1;
+}

Added: harmony/standard/site/docs/externals/vm_doc/html/luniglob_8c.html
URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/luniglob_8c.html?rev=724734&view=auto
==============================================================================
--- harmony/standard/site/docs/externals/vm_doc/html/luniglob_8c.html (added)
+++ harmony/standard/site/docs/externals/vm_doc/html/luniglob_8c.html Tue Dec  9 07:03:45 2008
@@ -0,0 +1,111 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Harmony Class Library Porting: modules/luni/src/main/native/luni/shared/luniglob.c File Reference</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.4 -->
+<div class="tabs">
+  <ul>
+    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+    <li><a href="modules.html"><span>Modules</span></a></li>
+    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
+    <li class="current"><a href="files.html"><span>Files</span></a></li>
+    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+  </ul>
+</div>
+<h1>modules/luni/src/main/native/luni/shared/luniglob.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Harmony LUNI natives initialization API. 
+<p>
+
+<p>
+<code>#include &lt;search.h&gt;</code><br>
+<code>#include &lt;string.h&gt;</code><br>
+<code>#include &lt;stdlib.h&gt;</code><br>
+<code>#include &quot;<a class="el" href="vmi_8h.html">vmi.h</a>&quot;</code><br>
+<code>#include &quot;harmonyglob.h&quot;</code><br>
+<code>#include &quot;<a class="el" href="hyport_8h.html">hyport.h</a>&quot;</code><br>
+<code>#include &quot;strhelp.h&quot;</code><br>
+<code>#include &quot;hycomp.h&quot;</code><br>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">JNIEXPORT jint JNICALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="luniglob_8c.html#ac0498b58a4bbbf42588d30433b4f8ea">JNI_OnLoad</a> (JavaVM *vm, void *reserved)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This DLL is being loaded, do any initialization required.  <a href="#ac0498b58a4bbbf42588d30433b4f8ea"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">JNIEXPORT void JNICALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="luniglob_8c.html#76bec78623b178fd9e8c142c457d1ac8">JNI_OnUnload</a> (JavaVM *vm, void *reserved)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This DLL is being unloaded, do any clean up required.  <a href="#76bec78623b178fd9e8c142c457d1ac8"></a><br></td></tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="ac0498b58a4bbbf42588d30433b4f8ea"></a><!-- doxytag: member="luniglob.c::JNI_OnLoad" ref="ac0498b58a4bbbf42588d30433b4f8ea" args="(JavaVM *vm, void *reserved)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">JNIEXPORT jint JNICALL JNI_OnLoad           </td>
+          <td>(</td>
+          <td class="paramtype">JavaVM *&nbsp;</td>
+          <td class="paramname"> <em>vm</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">void *&nbsp;</td>
+          <td class="paramname"> <em>reserved</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+This DLL is being loaded, do any initialization required. 
+<p>
+This may be called more than once. 
+</div>
+</div><p>
+<a class="anchor" name="76bec78623b178fd9e8c142c457d1ac8"></a><!-- doxytag: member="luniglob.c::JNI_OnUnload" ref="76bec78623b178fd9e8c142c457d1ac8" args="(JavaVM *vm, void *reserved)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">JNIEXPORT void JNICALL JNI_OnUnload           </td>
+          <td>(</td>
+          <td class="paramtype">JavaVM *&nbsp;</td>
+          <td class="paramname"> <em>vm</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">void *&nbsp;</td>
+          <td class="paramname"> <em>reserved</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+This DLL is being unloaded, do any clean up required. 
+<p>
+This may be called more than once!! 
+</div>
+</div><p>
+<hr size="1">
+<address style="text-align: center;">
+  <small>
+    <p>Genereated on Tue Dec 9 14:12:59 2008 by Doxygen.</p>
+    <p>(c) Copyright 2005, 2008 The Apache Software Foundation or its licensors, as applicable. </p>
+  </small>
+</address>
+</body>
+</html>

Propchange: harmony/standard/site/docs/externals/vm_doc/html/luniglob_8c.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: harmony/standard/site/docs/externals/vm_doc/html/modules.html
URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/modules.html?rev=724734&view=auto
==============================================================================
--- harmony/standard/site/docs/externals/vm_doc/html/modules.html (added)
+++ harmony/standard/site/docs/externals/vm_doc/html/modules.html Tue Dec  9 07:03:45 2008
@@ -0,0 +1,33 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Harmony Class Library Porting: Module Index</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.4 -->
+<div class="tabs">
+  <ul>
+    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+    <li class="current"><a href="modules.html"><span>Modules</span></a></li>
+    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
+    <li><a href="files.html"><span>Files</span></a></li>
+    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+  </ul>
+</div>
+<h1>Harmony Class Library Porting Modules</h1>Here is a list of all modules:<ul>
+<li><a class="el" href="group__VMInterface.html">VM Interface</a>
+<li><a class="el" href="group__Pool.html">Pool</a>
+<li><a class="el" href="group__Port.html">Port</a>
+<li><a class="el" href="group__Thread.html">Thread</a>
+<li><a class="el" href="group__ZipSupport.html">Zip Support</a>
+<li><a class="el" href="group__HarmonyNatives.html">Harmony JCL Natives</a>
+</ul>
+<hr size="1">
+<address style="text-align: center;">
+  <small>
+    <p>Genereated on Tue Dec 9 14:13:00 2008 by Doxygen.</p>
+    <p>(c) Copyright 2005, 2008 The Apache Software Foundation or its licensors, as applicable. </p>
+  </small>
+</address>
+</body>
+</html>

Propchange: harmony/standard/site/docs/externals/vm_doc/html/modules.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: harmony/standard/site/docs/externals/vm_doc/html/packaging.gif
URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/packaging.gif?rev=724734&view=auto
==============================================================================
Binary file - no diff available.

Propchange: harmony/standard/site/docs/externals/vm_doc/html/packaging.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: harmony/standard/site/docs/externals/vm_doc/html/pages.html
URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/pages.html?rev=724734&view=auto
==============================================================================
--- harmony/standard/site/docs/externals/vm_doc/html/pages.html (added)
+++ harmony/standard/site/docs/externals/vm_doc/html/pages.html Tue Dec  9 07:03:45 2008
@@ -0,0 +1,29 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Harmony Class Library Porting: Page Index</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.4 -->
+<div class="tabs">
+  <ul>
+    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+    <li><a href="modules.html"><span>Modules</span></a></li>
+    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
+    <li><a href="files.html"><span>Files</span></a></li>
+    <li class="current"><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+  </ul>
+</div>
+<h1>Harmony Class Library Porting Related Pages</h1>Here is a list of all related documentation pages:<ul>
+<li><a class="el" href="deprecated.html">Deprecated List</a>
+
+</ul>
+<hr size="1">
+<address style="text-align: center;">
+  <small>
+    <p>Genereated on Tue Dec 9 14:13:00 2008 by Doxygen.</p>
+    <p>(c) Copyright 2005, 2008 The Apache Software Foundation or its licensors, as applicable. </p>
+  </small>
+</address>
+</body>
+</html>

Propchange: harmony/standard/site/docs/externals/vm_doc/html/pages.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: harmony/standard/site/docs/externals/vm_doc/html/pool_8c.html
URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/pool_8c.html?rev=724734&view=auto
==============================================================================
--- harmony/standard/site/docs/externals/vm_doc/html/pool_8c.html (added)
+++ harmony/standard/site/docs/externals/vm_doc/html/pool_8c.html Tue Dec  9 07:03:45 2008
@@ -0,0 +1,484 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Harmony Class Library Porting: modules/portlib/src/main/native/pool/shared/pool.c File Reference</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.4 -->
+<div class="tabs">
+  <ul>
+    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+    <li><a href="modules.html"><span>Modules</span></a></li>
+    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
+    <li class="current"><a href="files.html"><span>Files</span></a></li>
+    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+  </ul>
+</div>
+<h1>modules/portlib/src/main/native/pool/shared/pool.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Pool primitives (creation, iteration, deletion, etc. 
+<p>
+) 
+<p>
+<code>#include &lt;stdio.h&gt;</code><br>
+<code>#include &lt;stdlib.h&gt;</code><br>
+<code>#include &lt;string.h&gt;</code><br>
+<code>#include &quot;<a class="el" href="hypool_8h.html">hypool.h</a>&quot;</code><br>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HyPool *VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#3a476dea150bf5b275f1149fd941618e">pool_new</a> (U_32 structSize, U_32 minNumberElements, U_32 elementAlignment, UDATA poolFlags, void *(VMCALL *memAlloc)(void *, U_32), void(VMCALL *memFree)(void *, void *), void *userData)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#1bc342e7a232db79be8ffd5c43912253">pool_kill</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deallocates all memory associated with a pool.  <a href="#1bc342e7a232db79be8ffd5c43912253"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void *VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#abf88a592e7890461b5bd0d2897f78fd">pool_newElement</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Asks for the address of a new pool element.  <a href="#abf88a592e7890461b5bd0d2897f78fd"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#3e3d8e0a0228e25263be24420389073c">pool_removeElement</a> (HyPool *aPool, void *anElement)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deallocates an element from a pool.  <a href="#3e3d8e0a0228e25263be24420389073c"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#826662db0a174a8a9e98407723167ed8">pool_do</a> (HyPool *aPool, void(*aFunction)(void *anElement, void *userData), void *userData)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calls a user provided function for each element in the list.  <a href="#826662db0a174a8a9e98407723167ed8"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">UDATA VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#d06bfa9f9fa0dc351a8bab758745a4bc">pool_numElements</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of elements in a given pool.  <a href="#d06bfa9f9fa0dc351a8bab758745a4bc"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void *VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#f2ca22356fb6793947d51bbbd5d93fc7">pool_startDo</a> (HyPool *aPool, pool_state *lastHandle)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void *VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#18c3db16ce440b618dc117bea019e5b8">pool_nextDo</a> (pool_state *lastHandle)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#cda868970a74c3b6977a10003f350485">pool_sortFree</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sorts the free list of the current pool.  <a href="#cda868970a74c3b6977a10003f350485"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HyPool *VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#a14c22685a150883b5073da3ac4c838e">pool_forPortLib</a> (U_32 structSize, <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shortcut for <a class="el" href="pool_8c.html#pool_new">pool_new</a>, using the default malloc/free from the portLibrary.  <a href="#a14c22685a150883b5073da3ac4c838e"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#a59aa55452f6fb06070f91f3bcb0806d">pool_clear</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clear the contents of a pool but not delete it.  <a href="#a59aa55452f6fb06070f91f3bcb0806d"></a><br></td></tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="a59aa55452f6fb06070f91f3bcb0806d"></a><!-- doxytag: member="pool.c::pool_clear" ref="a59aa55452f6fb06070f91f3bcb0806d" args="(HyPool *aPool)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">pool_clear           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Clear the contents of a pool but not delete it. 
+<p>
+<dl class="note" compact><dt><b>Note:</b></dt><dd>Make no assumptions about the contents of the pool after invoking this method (it currently does not zero the memory)</dd></dl>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td>The pool to clear</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>none </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="826662db0a174a8a9e98407723167ed8"></a><!-- doxytag: member="pool.c::pool_do" ref="826662db0a174a8a9e98407723167ed8" args="(HyPool *aPool, void(*aFunction)(void *anElement, void *userData), void *userData)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">pool_do           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">void(*)(void *anElement, void *userData)&nbsp;</td>
+          <td class="paramname"> <em>aFunction</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">void *&nbsp;</td>
+          <td class="paramname"> <em>userData</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Calls a user provided function for each element in the list. 
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td>The pool to "do" things to </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aFunction</em>&nbsp;</td><td>Pointer to function which will "do" things to the elements of aPool </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>userData</em>&nbsp;</td><td>Pointer to data to be passed to "do" function, along with each pool-element</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>none</dd></dl>
+<dl class="see" compact><dt><b>See also:</b></dt><dd>pool_startDo, pool_nextDo </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="a14c22685a150883b5073da3ac4c838e"></a><!-- doxytag: member="pool.c::pool_forPortLib" ref="a14c22685a150883b5073da3ac4c838e" args="(U_32 structSize, HyPortLibrary *portLibrary)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">pool_forPortLib           </td>
+          <td>(</td>
+          <td class="paramtype">U_32&nbsp;</td>
+          <td class="paramname"> <em>structSize</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *&nbsp;</td>
+          <td class="paramname"> <em>portLibrary</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Shortcut for <a class="el" href="pool_8c.html#pool_new">pool_new</a>, using the default malloc/free from the portLibrary. 
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>structSize</em>&nbsp;</td><td>size of pool-element </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>portLibrary</em>&nbsp;</td><td></td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to a Pool</dd></dl>
+<dl class="see" compact><dt><b>See also:</b></dt><dd>pool_new </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="1bc342e7a232db79be8ffd5c43912253"></a><!-- doxytag: member="pool.c::pool_kill" ref="1bc342e7a232db79be8ffd5c43912253" args="(HyPool *aPool)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">pool_kill           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Deallocates all memory associated with a pool. 
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td>Pool to be deallocated</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>none </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="3a476dea150bf5b275f1149fd941618e"></a><!-- doxytag: member="pool.c::pool_new" ref="3a476dea150bf5b275f1149fd941618e" args="(U_32 structSize, U_32 minNumberElements, U_32 elementAlignment, UDATA poolFlags, void *(VMCALL *memAlloc)(void *, U_32), void(VMCALL *memFree)(void *, void *), void *userData)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">pool_new           </td>
+          <td>(</td>
+          <td class="paramtype">U_32&nbsp;</td>
+          <td class="paramname"> <em>structSize</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">U_32&nbsp;</td>
+          <td class="paramname"> <em>minNumberElements</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">U_32&nbsp;</td>
+          <td class="paramname"> <em>elementAlignment</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">UDATA&nbsp;</td>
+          <td class="paramname"> <em>poolFlags</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">void *&nbsp;</td>
+          <td class="paramname">(VMCALL *memAlloc)(void *, U_32), </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">void(VMCALL *memFree)(void *, void *)&nbsp;</td>
+          <td class="paramname">, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">void *&nbsp;</td>
+          <td class="paramname"> <em>userData</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+<h2><a class="anchor" name="pool_new">
+pool_new</a></h2>
+Returns a handle to a variable sized pool of structures. This handle should be passed into all other pool functions.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>structSize</em>&nbsp;</td><td>Size of the pool-elements </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>minNumberElements</em>&nbsp;</td><td>If zero, will default to 1 </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>elementAlignment</em>&nbsp;</td><td>If zero will default to MIN_GRANULARITY </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>poolFlags</em>&nbsp;</td><td></td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>memAlloc</em>&nbsp;</td><td>Allocate function pointer </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>memFree</em>&nbsp;</td><td>Free function pointer </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>userData</em>&nbsp;</td><td></td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to a new pool </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="abf88a592e7890461b5bd0d2897f78fd"></a><!-- doxytag: member="pool.c::pool_newElement" ref="abf88a592e7890461b5bd0d2897f78fd" args="(HyPool *aPool)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">pool_newElement           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Asks for the address of a new pool element. 
+<p>
+If it succeeds, the address returned will have space for one element of the correct structure size. The contents of the element are undefined. If the current pool is full, a new one will be grafted onto the end of the pool chain and memory from there will be used.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td></td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>NULL on error <p>
+pointer to a new element otherwise </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="18c3db16ce440b618dc117bea019e5b8"></a><!-- doxytag: member="pool.c::pool_nextDo" ref="18c3db16ce440b618dc117bea019e5b8" args="(pool_state *lastHandle)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">pool_nextDo           </td>
+          <td>(</td>
+          <td class="paramtype">pool_state *&nbsp;</td>
+          <td class="paramname"> <em>lastHandle</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+<h2><a class="anchor" name="pool_nextDo">
+pool_nextDo</a></h2>
+Continue an iteration based on state passed in by lastHandle. It is safe to stop an iteration midway through.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>lastHandle</em>&nbsp;</td><td>pointer for current iteration state</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>NULL nothing more to be done <p>
+pointer to next element to be processed otherwise</dd></dl>
+<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="hypool_8h.html#cdc4233f475ea905a8ac7c4f5dc6e373" title="Calls a user provided function for each element in the list.">pool_do</a>, pool_startDo </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="d06bfa9f9fa0dc351a8bab758745a4bc"></a><!-- doxytag: member="pool.c::pool_numElements" ref="d06bfa9f9fa0dc351a8bab758745a4bc" args="(HyPool *aPool)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">pool_numElements           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Returns the number of elements in a given pool. 
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td></td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on error <p>
+the number of elements in the pool otherwise </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="3e3d8e0a0228e25263be24420389073c"></a><!-- doxytag: member="pool.c::pool_removeElement" ref="3e3d8e0a0228e25263be24420389073c" args="(HyPool *aPool, void *anElement)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">pool_removeElement           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">void *&nbsp;</td>
+          <td class="paramname"> <em>anElement</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Deallocates an element from a pool. 
+<p>
+It is safe to call <a class="el" href="pool_8c.html#3e3d8e0a0228e25263be24420389073c" title="Deallocates an element from a pool.">pool_removeElement()</a> while looping over the pool with <a class="el" href="pool_8c.html#pool_startDo">pool_startDo</a> / <a class="el" href="pool_8c.html#pool_nextDo">pool_nextDo</a> on the element returned by those calls. This is because the free element is always inserted at either the head of the free list or before the nextFree element in the pool_state.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td></td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>anElement</em>&nbsp;</td><td>Pointer to the element to be removed</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>none </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="cda868970a74c3b6977a10003f350485"></a><!-- doxytag: member="pool.c::pool_sortFree" ref="cda868970a74c3b6977a10003f350485" args="(HyPool *aPool)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">pool_sortFree           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Sorts the free list of the current pool. 
+<p>
+(ie: does not follow nextPool pointers...) This is a O(n) most of the time.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td>The pool to be sorted</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>none </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="f2ca22356fb6793947d51bbbd5d93fc7"></a><!-- doxytag: member="pool.c::pool_startDo" ref="f2ca22356fb6793947d51bbbd5d93fc7" args="(HyPool *aPool, pool_state *lastHandle)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">pool_startDo           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">pool_state *&nbsp;</td>
+          <td class="paramname"> <em>lastHandle</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+<h2><a class="anchor" name="pool_startDo">
+pool_startDo</a></h2>
+Start of an iteration set that will return when code is to be executed. This is based strongly on pool_sortFreeAndIterateUsed. Pass in a pointer to an empty pool_state and it will be filled in.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td>The pool to "do" things to </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>lastHandle</em>&nbsp;</td><td></td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>NULL <p>
+pointer to element otherwise</dd></dl>
+<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="hypool_8h.html#cdc4233f475ea905a8ac7c4f5dc6e373" title="Calls a user provided function for each element in the list.">pool_do</a>, pool_nextDo </dd></dl>
+
+</div>
+</div><p>
+<hr size="1">
+<address style="text-align: center;">
+  <small>
+    <p>Genereated on Tue Dec 9 14:12:59 2008 by Doxygen.</p>
+    <p>(c) Copyright 2005, 2008 The Apache Software Foundation or its licensors, as applicable. </p>
+  </small>
+</address>
+</body>
+</html>

Propchange: harmony/standard/site/docs/externals/vm_doc/html/pool_8c.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: harmony/standard/site/docs/externals/vm_doc/html/pool__cap_8c.html
URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/pool__cap_8c.html?rev=724734&view=auto
==============================================================================
--- harmony/standard/site/docs/externals/vm_doc/html/pool__cap_8c.html (added)
+++ harmony/standard/site/docs/externals/vm_doc/html/pool__cap_8c.html Tue Dec  9 07:03:45 2008
@@ -0,0 +1,114 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Harmony Class Library Porting: modules/portlib/src/main/native/pool/shared/pool_cap.c File Reference</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.4 -->
+<div class="tabs">
+  <ul>
+    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+    <li><a href="modules.html"><span>Modules</span></a></li>
+    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
+    <li class="current"><a href="files.html"><span>Files</span></a></li>
+    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+  </ul>
+</div>
+<h1>modules/portlib/src/main/native/pool/shared/pool_cap.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Pool-capacity functions. 
+<p>
+
+<p>
+<code>#include &lt;stdio.h&gt;</code><br>
+<code>#include &lt;stdlib.h&gt;</code><br>
+<code>#include &lt;string.h&gt;</code><br>
+<code>#include &quot;<a class="el" href="hypool_8h.html">hypool.h</a>&quot;</code><br>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">UDATA VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pool__cap_8c.html#35f8f2556069a0b32de79262671f3839">pool_ensureCapacity</a> (HyPool *aPool, UDATA newCapacity)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Ensures that the pool is large enough for newCapacity elements.  <a href="#35f8f2556069a0b32de79262671f3839"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">UDATA VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pool__cap_8c.html#06ad3f11f7c04baf991d90c381282bff">pool_capacity</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the total capacity of a pool.  <a href="#06ad3f11f7c04baf991d90c381282bff"></a><br></td></tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="06ad3f11f7c04baf991d90c381282bff"></a><!-- doxytag: member="pool_cap.c::pool_capacity" ref="06ad3f11f7c04baf991d90c381282bff" args="(HyPool *aPool)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">UDATA VMCALL pool_capacity           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Returns the total capacity of a pool. 
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td>The pool</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on error <p>
+numElements in aPool otherwise </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="35f8f2556069a0b32de79262671f3839"></a><!-- doxytag: member="pool_cap.c::pool_ensureCapacity" ref="35f8f2556069a0b32de79262671f3839" args="(HyPool *aPool, UDATA newCapacity)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">UDATA VMCALL pool_ensureCapacity           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">UDATA&nbsp;</td>
+          <td class="paramname"> <em>newCapacity</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Ensures that the pool is large enough for newCapacity elements. 
+<p>
+This has the side effect of setting the POOL_NEVER_FREE_PUDDLES flag. Without this, the pool could shrink back down to its original size. Note that this does not take into account the number of elements already used in the pool.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td>The pool </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>newCapacity</em>&nbsp;</td><td>The desired new-size of the pool</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success <p>
+-1 on failure </dd></dl>
+
+</div>
+</div><p>
+<hr size="1">
+<address style="text-align: center;">
+  <small>
+    <p>Genereated on Tue Dec 9 14:12:59 2008 by Doxygen.</p>
+    <p>(c) Copyright 2005, 2008 The Apache Software Foundation or its licensors, as applicable. </p>
+  </small>
+</address>
+</body>
+</html>

Propchange: harmony/standard/site/docs/externals/vm_doc/html/pool__cap_8c.html
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message