Loading...
Helix SwarmHelix Swarm
Loading...

HelixWebServices.html

  • //
  • guest/
  • ptomiak/
  • hws/
  • build/
  • doc/
  • helix_web_services/
  • HelixWebServices.html #1
  • View
  • Commits
  • Open Download .zip Download (5 KB) 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4.   <head>
  5.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>
  7.   Module: HelixWebServices
  8.   
  9.     &mdash; Documentation by YARD 0.8.7.6
  10.   
  11. </title>
  12.  
  13.   <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
  14.  
  15.   <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
  16.  
  17. <script type="text/javascript" charset="utf-8">
  18.   hasFrames = window.top.frames.main ? true : false;
  19.   relpath = '';
  20.   framesUrl = "frames.html#!HelixWebServices.html";
  21. </script>
  22.  
  23.  
  24.   <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
  25.  
  26.   <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
  27.  
  28.  
  29.   </head>
  30.   <body>
  31.     <div id="header">
  32.       <div id="menu">
  33.   
  34.     <a href="_index.html">Index (H)</a> &raquo;
  35.     
  36.     
  37.     <span class="title">HelixWebServices</span>
  38.   
  39.  
  40.   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
  41. </div>
  42.  
  43.       <div id="search">
  44.   
  45.     <a class="full_list_link" id="class_list_link"
  46.         href="class_list.html">
  47.       Class List
  48.     </a>
  49.   
  50.     <a class="full_list_link" id="method_list_link"
  51.         href="method_list.html">
  52.       Method List
  53.     </a>
  54.   
  55.     <a class="full_list_link" id="file_list_link"
  56.         href="file_list.html">
  57.       File List
  58.     </a>
  59.   
  60. </div>
  61.       <div class="clear"></div>
  62.     </div>
  63.  
  64.     <iframe id="search_frame"></iframe>
  65.  
  66.     <div id="content"><h1>Module: HelixWebServices
  67.   
  68.   
  69.   
  70. </h1>
  71.  
  72. <dl class="box">
  73.   
  74.   
  75.     
  76.   
  77.     
  78.   
  79.   
  80.   
  81.     <dt class="r1 last">Defined in:</dt>
  82.     <dd class="r1 last">lib/helix_web_services/version.rb<span class="defines">,<br />
  83.   lib/helix_web_services.rb,<br /> lib/helix_web_services/version.rb,<br /> lib/helix_web_services/build_version.rb</span>
  84. </dd>
  85.   
  86. </dl>
  87. <div class="clear"></div>
  88.  
  89. <h2>Overview</h2><div class="docstring">
  90.   <div class="discussion">
  91.     
  92. <p>Version strings in HWS</p>
  93.  
  94. <p>The main “Ruby” string is a legal version of our “Product Release
  95. Identification Standard”:</p>
  96.  
  97. <p><a
  98. href="https://confluence.perforce.com:8443/display/EN/Product+Release+Identification+Standards">confluence.perforce.com:8443/display/EN/Product+Release+Identification+Standards</a></p>
  99.  
  100. <p>A few notes:</p>
  101. <ol><li>
  102. <p>While HWS does build for different OSes, it does not have an explicit 
  103. architecture. So we use "NOARCH".</p>
  104. </li><li>
  105. <p>The "Product ID" is currently "HWS".</p>
  106. </li><li>
  107. <p>We do include the date and changelist of the <em>tarball</em>.</p>
  108. </li></ol>
  109.  
  110. <p>An official verison may be: HWS/NOARCH/2015.1/123456 (2015/08/17)</p>
  111.  
  112. <p>A pre-release version will include information in the middle:</p>
  113.  
  114. <p>HWS/NOARCH/2015.1.MAIN-TEST_ONLY/123456 (2015/08/17)</p>
  115.  
  116. <p>For Ruby, the version string will be [<a
  117. href="REV">YEAR].</a>.[CHANGELIST]. Preleases will have a branch specifier:
  118. [<a href="REV">YEAR].</a>.<a href="branch">0.</a>[CHANGELIST].</p>
  119.  
  120. <p>Ergo, a Ruby version string will look like 2015.1.0.main123456</p>
  121.  
  122. <p>These strings are either defined in a file <code>./build_version.rb</code>.</p>
  123.  
  124.  
  125.   </div>
  126. </div>
  127. <div class="tags">
  128.   
  129.  
  130. </div><h2>Defined Under Namespace</h2>
  131. <p class="children">
  132.   
  133.     
  134.       <strong class="modules">Modules:</strong> <span class='object_link'><a href="HelixWebServices/ErrorHandling.html" title="HelixWebServices::ErrorHandling (module)">ErrorHandling</a></span>
  135.     
  136.   
  137.     
  138.       <strong class="classes">Classes:</strong> <span class='object_link'><a href="HelixWebServices/Master.html" title="HelixWebServices::Master (class)">Master</a></span>
  139.     
  140.   
  141. </p>
  142.  
  143.   <h2>Constant Summary</h2>
  144.   
  145.     <dl class="constants">
  146.       
  147.         <dt id="VERSION-constant" class="">VERSION =
  148.           
  149.         </dt>
  150.         <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>2015.1.0.main</span><span class='tstring_end'>&#39;</span></span></pre></dd>
  151.       
  152.         <dt id="PRODUCT_ID-constant" class="">PRODUCT_ID =
  153.           
  154.         </dt>
  155.         <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>HWS/NOARCH/2015.1.main/201509150120</span><span class='tstring_end'>&#39;</span></span></pre></dd>
  156.       
  157.     </dl>
  158.   
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168. </div>
  169.  
  170.     <div id="footer">
  171.   Generated on Tue Sep 15 01:20:28 2015 by
  172.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  173.   0.8.7.6 (ruby-2.2.3).
  174. </div>
  175.  
  176.   </body>
  177. </html>
# Change User Description Committed
#1 15741 ptomiak Branch HWS for my use. 10 years ago