[Abtlinux-svn] SF.net SVN: abtlinux: [90] src/trunk

[<esc...@us...>]

Revision: 90
Author:   eschabell
Date:     2006-05-17 04:38:05 -0700 (Wed, 17 May 2006)
ViewCVS:  http://svn.sourceforge.net/abtlinux/?rev=90&view=rev

Log Message:
-----------
Added attributes for Package class.

Modified Paths:
--------------
    src/trunk/Package.rb
    src/trunk/doc/classes/Package.html
    src/trunk/doc/created.rid
    src/trunk/doc/files/Package_rb.html
Modified: src/trunk/Package.rb
===================================================================
--- src/trunk/Package.rb	2006-05-17 09:24:27 UTC (rev 89)
+++ src/trunk/Package.rb	2006-05-17 11:38:05 UTC (rev 90)
@@ -30,19 +30,23 @@
 
 class Package
 
+  attr_reader :name, :version, :srcfile
+  attr_reader :srcdir, :srcurl, :integrity
+  attr_reader :url, :licence, :description
+
   ##
   # Provides all the data needed for this package.
   #
-  # RETURNS:  HASH containing all package information.
+  # <b>RETURNS:</b>  <i>hash</i> - Contains all package information.
   ##
 	def details
 	end
 	
   ##
-  # PREliminary work will happen here such as downloading the tarball, 
+  # Preliminary work will happen here such as downloading the tarball, 
   # unpacking it, downloading and applying patches.
   #
-  # RETURNS:  boolean True if completes sucessfully, otherwise false.
+  # <b>RETURNS:</b>  <i>boolean</i> - True if completes sucessfully, otherwise false.
   ##
 	def pre
 	end
@@ -54,7 +58,7 @@
   # Don't forget too that it's here where we interact with the user in case there are optionnal 
   # dependencies.
   #
-  # RETURNS:  boolean True if the completes sucessfully, otherwise false.
+  # <b>RETURNS:</b>  <i>boolean</i> - True if the completes sucessfully, otherwise false.
   ##
   def configure
   end
@@ -62,7 +66,7 @@
   ##
   # Here is where the actual builing of the software starts, for example running 'make'.
   #
-  # RETURNS:  boolean True if the completes sucessfully, otherwise false.
+  # <b>RETURNS:</b>  <i>boolean</i> - True if the completes sucessfully, otherwise false.
   ##
   def build
   end
@@ -71,7 +75,7 @@
   # Any actions needed before the installation can occur will happen here, such as creating
   # new user accounts, dealing with existing configuration files, etc.
   #
-  # RETURNS:  boolean True if the completes sucessfully, otherwise false.
+  # <b>RETURNS:</b>  <i>boolean</i> - True if the completes sucessfully, otherwise false.
   ##
   def preinstall
   end
@@ -79,7 +83,7 @@
   ##
   # All files to be installed are installed here.
   #
-  # RETURNS:  boolean True if the completes sucessfully, otherwise false.
+  # <b>RETURNS:</b>  <i>boolean</i> - True if the completes sucessfully, otherwise false.
   ##
   def install
   end
@@ -87,7 +91,7 @@
   ##
   # Last bits of installation. adding the service for automatic start in init.d for example.
   #
-  # RETURNS:  boolean True if the completes sucessfully, otherwise false.
+  # <b>RETURNS:</b>  <i>boolean</i> - True if the completes sucessfully, otherwise false.
   ##
   def post
   end

Modified: src/trunk/doc/classes/Package.html
===================================================================
--- src/trunk/doc/classes/Package.html	2006-05-17 09:24:27 UTC (rev 89)
+++ src/trunk/doc/classes/Package.html	2006-05-17 11:38:05 UTC (rev 90)
@@ -132,6 +132,72 @@
 
 
 
+  <div class="sectiontitle">Attributes</div>
+  <table border='0' cellpadding='5'>
+  <tr valign='top'>
+    <td class='attr-rw'>
+[R]
+    </td>
+    <td class='attr-name'>description</td>
+    <td class='attr-desc'></td>
+  </tr>
+  <tr valign='top'>
+    <td class='attr-rw'>
+[R]
+    </td>
+    <td class='attr-name'>integrity</td>
+    <td class='attr-desc'></td>
+  </tr>
+  <tr valign='top'>
+    <td class='attr-rw'>
+[R]
+    </td>
+    <td class='attr-name'>licence</td>
+    <td class='attr-desc'></td>
+  </tr>
+  <tr valign='top'>
+    <td class='attr-rw'>
+[R]
+    </td>
+    <td class='attr-name'>name</td>
+    <td class='attr-desc'></td>
+  </tr>
+  <tr valign='top'>
+    <td class='attr-rw'>
+[R]
+    </td>
+    <td class='attr-name'>srcdir</td>
+    <td class='attr-desc'></td>
+  </tr>
+  <tr valign='top'>
+    <td class='attr-rw'>
+[R]
+    </td>
+    <td class='attr-name'>srcfile</td>
+    <td class='attr-desc'></td>
+  </tr>
+  <tr valign='top'>
+    <td class='attr-rw'>
+[R]
+    </td>
+    <td class='attr-name'>srcurl</td>
+    <td class='attr-desc'></td>
+  </tr>
+  <tr valign='top'>
+    <td class='attr-rw'>
+[R]
+    </td>
+    <td class='attr-name'>url</td>
+    <td class='attr-desc'></td>
+  </tr>
+  <tr valign='top'>
+    <td class='attr-rw'>
+[R]
+    </td>
+    <td class='attr-name'>version</td>
+    <td class='attr-desc'></td>
+  </tr>
+  </table>
 
 <div class="sectiontitle">Public Instance methods</div>
 <div class="method">
@@ -144,16 +210,17 @@
 running &#8216;make&#8217;.
 </p>
 <p>
-RETURNS: boolean True if the completes sucessfully, otherwise false.
+<b>RETURNS:</b> <em>boolean</em> - True if the completes sucessfully,
+otherwise false.
 </p>
   </div>
 <div class="sourcecode">
   <p class="source-link">[ <a href="javascript:toggleSource('M000004_source')" id="l_M000004_source">show source</a> ]</p>
   <div id="M000004_source" class="dyn-source">
 <pre>
-    <span class="ruby-comment cmt"># File Package.rb, line 67</span>
-67:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">build</span>
-68:   <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File Package.rb, line 71</span>
+71:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">build</span>
+72:   <span class="ruby-keyword kw">end</span>
 </pre>
   </div>
 </div>
@@ -172,16 +239,17 @@
 dependencies.
 </p>
 <p>
-RETURNS: boolean True if the completes sucessfully, otherwise false.
+<b>RETURNS:</b> <em>boolean</em> - True if the completes sucessfully,
+otherwise false.
 </p>
   </div>
 <div class="sourcecode">
   <p class="source-link">[ <a href="javascript:toggleSource('M000003_source')" id="l_M000003_source">show source</a> ]</p>
   <div id="M000003_source" class="dyn-source">
 <pre>
-    <span class="ruby-comment cmt"># File Package.rb, line 59</span>
-59:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configure</span>
-60:   <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File Package.rb, line 63</span>
+63:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configure</span>
+64:   <span class="ruby-keyword kw">end</span>
 </pre>
   </div>
 </div>
@@ -195,16 +263,16 @@
 Provides all the data needed for this package.
 </p>
 <p>
-RETURNS: HASH containing all package information.
+<b>RETURNS:</b> <em>hash</em> - Contains all package information.
 </p>
   </div>
 <div class="sourcecode">
   <p class="source-link">[ <a href="javascript:toggleSource('M000001_source')" id="l_M000001_source">show source</a> ]</p>
   <div id="M000001_source" class="dyn-source">
 <pre>
-    <span class="ruby-comment cmt"># File Package.rb, line 38</span>
-38:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">details</span>
-39:         <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File Package.rb, line 42</span>
+42:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">details</span>
+43:         <span class="ruby-keyword kw">end</span>
 </pre>
   </div>
 </div>
@@ -218,16 +286,17 @@
 All files to be installed are installed here.
 </p>
 <p>
-RETURNS: boolean True if the completes sucessfully, otherwise false.
+<b>RETURNS:</b> <em>boolean</em> - True if the completes sucessfully,
+otherwise false.
 </p>
   </div>
 <div class="sourcecode">
   <p class="source-link">[ <a href="javascript:toggleSource('M000006_source')" id="l_M000006_source">show source</a> ]</p>
   <div id="M000006_source" class="dyn-source">
 <pre>
-    <span class="ruby-comment cmt"># File Package.rb, line 84</span>
-84:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">install</span>
-85:   <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File Package.rb, line 88</span>
+88:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">install</span>
+89:   <span class="ruby-keyword kw">end</span>
 </pre>
   </div>
 </div>
@@ -242,16 +311,17 @@
 for example.
 </p>
 <p>
-RETURNS: boolean True if the completes sucessfully, otherwise false.
+<b>RETURNS:</b> <em>boolean</em> - True if the completes sucessfully,
+otherwise false.
 </p>
   </div>
 <div class="sourcecode">
   <p class="source-link">[ <a href="javascript:toggleSource('M000007_source')" id="l_M000007_source">show source</a> ]</p>
   <div id="M000007_source" class="dyn-source">
 <pre>
-    <span class="ruby-comment cmt"># File Package.rb, line 92</span>
-92:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">post</span>
-93:   <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File Package.rb, line 96</span>
+96:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">post</span>
+97:   <span class="ruby-keyword kw">end</span>
 </pre>
   </div>
 </div>
@@ -262,20 +332,21 @@
   </div>
   <div class="description">
   <p>
-PREliminary work will happen here such as downloading the tarball,
+Preliminary work will happen here such as downloading the tarball,
 unpacking it, downloading and applying patches.
 </p>
 <p>
-RETURNS: boolean True if completes sucessfully, otherwise false.
+<b>RETURNS:</b> <em>boolean</em> - True if completes sucessfully, otherwise
+false.
 </p>
   </div>
 <div class="sourcecode">
   <p class="source-link">[ <a href="javascript:toggleSource('M000002_source')" id="l_M000002_source">show source</a> ]</p>
   <div id="M000002_source" class="dyn-source">
 <pre>
-    <span class="ruby-comment cmt"># File Package.rb, line 47</span>
-47:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pre</span>
-48:         <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File Package.rb, line 51</span>
+51:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pre</span>
+52:         <span class="ruby-keyword kw">end</span>
 </pre>
   </div>
 </div>
@@ -291,16 +362,17 @@
 etc.
 </p>
 <p>
-RETURNS: boolean True if the completes sucessfully, otherwise false.
+<b>RETURNS:</b> <em>boolean</em> - True if the completes sucessfully,
+otherwise false.
 </p>
   </div>
 <div class="sourcecode">
   <p class="source-link">[ <a href="javascript:toggleSource('M000005_source')" id="l_M000005_source">show source</a> ]</p>
   <div id="M000005_source" class="dyn-source">
 <pre>
-    <span class="ruby-comment cmt"># File Package.rb, line 76</span>
-76:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">preinstall</span>
-77:   <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File Package.rb, line 80</span>
+80:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">preinstall</span>
+81:   <span class="ruby-keyword kw">end</span>
 </pre>
   </div>
 </div>

Modified: src/trunk/doc/created.rid
===================================================================
--- src/trunk/doc/created.rid	2006-05-17 09:24:27 UTC (rev 89)
+++ src/trunk/doc/created.rid	2006-05-17 11:38:05 UTC (rev 90)
@@ -1 +1 @@
-Wed May 17 11:20:59 CEST 2006
+Wed May 17 13:37:16 CEST 2006

Modified: src/trunk/doc/files/Package_rb.html
===================================================================
--- src/trunk/doc/files/Package_rb.html	2006-05-17 09:24:27 UTC (rev 89)
+++ src/trunk/doc/files/Package_rb.html	2006-05-17 11:38:05 UTC (rev 90)
@@ -63,7 +63,7 @@
           </tr>
           <tr>
             <td>Modified:</td>
-            <td>Wed May 17 11:20:54 CEST 2006</td>
+            <td>Wed May 17 13:37:07 CEST 2006</td>
           </tr>
         </table>
       </td></tr>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.