PageRenderTime 59ms CodeModel.GetById 23ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/gem.doc-0.4.0/classes/Doc/RootMerger.html

https://github.com/toy/rb
HTML | 234 lines | 145 code | 89 blank | 0 comment | 0 complexity | e715babe59a508877806cdc0109412cd MD5 | raw file
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  3. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  5. <head>
  6. <title>Doc::RootMerger</title>
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  8. <link rel="stylesheet" href="../../css/reset.css" type="text/css" media="screen" />
  9. <link rel="stylesheet" href="../../css/main.css" type="text/css" media="screen" />
  10. <script src="../../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
  11. <script src="../../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
  12. <script src="../../js/main.js" type="text/javascript" charset="utf-8"></script>
  13. </head>
  14. <body>
  15. <div class="banner">
  16. <h1>
  17. <span class="type">Class</span>
  18. Doc::RootMerger
  19. <span class="parent">&lt;
  20. Merger
  21. </span>
  22. </h1>
  23. <ul class="files">
  24. <li><a href="../../files/lib/doc/root_merger_rb.html">lib/doc/root_merger.rb</a></li>
  25. </ul>
  26. </div>
  27. <div id="bodyContent">
  28. <div id="content">
  29. <div class="sectiontitle">Methods</div>
  30. <dl class="methods">
  31. <dt>D</dt>
  32. <dd>
  33. <ul>
  34. <li><a href="#M000107">doc_dir</a></li>
  35. </ul>
  36. </dd>
  37. <dt>P</dt>
  38. <dd>
  39. <ul>
  40. <li><a href="#M000109">progress_message</a>,</li>
  41. <li><a href="#M000108">public_doc_dir</a></li>
  42. </ul>
  43. </dd>
  44. <dt>R</dt>
  45. <dd>
  46. <ul>
  47. <li><a href="#M000110">run</a></li>
  48. </ul>
  49. </dd>
  50. <dt>T</dt>
  51. <dd>
  52. <ul>
  53. <li><a href="#M000111">task_url</a></li>
  54. </ul>
  55. </dd>
  56. </dl>
  57. <div class="sectiontitle">Instance Public methods</div>
  58. <div class="method">
  59. <div class="title" id="M000107">
  60. <a name="M000107"></a><b>doc_dir</b>()
  61. </div>
  62. <div class="sourcecode">
  63. <p class="source-link">
  64. Source: <a href="javascript:toggleSource('M000107_source')" id="l_M000107_source">show</a>
  65. </p>
  66. <div id="M000107_source" class="dyn-source">
  67. <pre> <span class="ruby-comment cmt"># File lib/doc/root_merger.rb, line 3</span>
  68. 3: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">doc_dir</span>
  69. 4: <span class="ruby-identifier">documentor</span>.<span class="ruby-identifier">public_dir</span>
  70. 5: <span class="ruby-keyword kw">end</span></pre>
  71. </div>
  72. </div>
  73. </div>
  74. <div class="method">
  75. <div class="title" id="M000109">
  76. <a name="M000109"></a><b>progress_message</b>()
  77. </div>
  78. <div class="sourcecode">
  79. <p class="source-link">
  80. Source: <a href="javascript:toggleSource('M000109_source')" id="l_M000109_source">show</a>
  81. </p>
  82. <div id="M000109_source" class="dyn-source">
  83. <pre> <span class="ruby-comment cmt"># File lib/doc/root_merger.rb, line 11</span>
  84. 11: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">progress_message</span>
  85. 12: <span class="ruby-value str">'building docs'</span>
  86. 13: <span class="ruby-keyword kw">end</span></pre>
  87. </div>
  88. </div>
  89. </div>
  90. <div class="method">
  91. <div class="title" id="M000108">
  92. <a name="M000108"></a><b>public_doc_dir</b>()
  93. </div>
  94. <div class="sourcecode">
  95. <p class="source-link">
  96. Source: <a href="javascript:toggleSource('M000108_source')" id="l_M000108_source">show</a>
  97. </p>
  98. <div id="M000108_source" class="dyn-source">
  99. <pre> <span class="ruby-comment cmt"># File lib/doc/root_merger.rb, line 7</span>
  100. 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">public_doc_dir</span>
  101. 8: <span class="ruby-identifier">doc_dir</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">documentor</span>.<span class="ruby-identifier">docs_dir</span>.<span class="ruby-identifier">basename</span>
  102. 9: <span class="ruby-keyword kw">end</span></pre>
  103. </div>
  104. </div>
  105. </div>
  106. <div class="method">
  107. <div class="title" id="M000110">
  108. <a name="M000110"></a><b>run</b>()
  109. </div>
  110. <div class="sourcecode">
  111. <p class="source-link">
  112. Source: <a href="javascript:toggleSource('M000110_source')" id="l_M000110_source">show</a>
  113. </p>
  114. <div id="M000110_source" class="dyn-source">
  115. <pre> <span class="ruby-comment cmt"># File lib/doc/root_merger.rb, line 15</span>
  116. 15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>
  117. 16: <span class="ruby-keyword kw">super</span>
  118. 17: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">succeeded?</span>
  119. 18: <span class="ruby-identifier">public_doc_dir</span>.<span class="ruby-identifier">mkpath</span>
  120. 19: <span class="ruby-identifier">symlink_children_to</span>(<span class="ruby-identifier">public_doc_dir</span>)
  121. 20: <span class="ruby-keyword kw">end</span>
  122. 21: <span class="ruby-keyword kw">end</span></pre>
  123. </div>
  124. </div>
  125. </div>
  126. <div class="method">
  127. <div class="title" id="M000111">
  128. <a name="M000111"></a><b>task_url</b>(task)
  129. </div>
  130. <div class="sourcecode">
  131. <p class="source-link">
  132. Source: <a href="javascript:toggleSource('M000111_source')" id="l_M000111_source">show</a>
  133. </p>
  134. <div id="M000111_source" class="dyn-source">
  135. <pre> <span class="ruby-comment cmt"># File lib/doc/root_merger.rb, line 23</span>
  136. 23: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">task_url</span>(<span class="ruby-identifier">task</span>)
  137. 24: <span class="ruby-identifier">documentor</span>.<span class="ruby-identifier">docs_dir</span>.<span class="ruby-identifier">basename</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">task</span>.<span class="ruby-identifier">doc_dir</span>.<span class="ruby-identifier">basename</span>
  138. 25: <span class="ruby-keyword kw">end</span></pre>
  139. </div>
  140. </div>
  141. </div>
  142. </div>
  143. </div>
  144. </body>
  145. </html>