diff options
author | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2012-12-30 14:43:00 +0200 |
---|---|---|
committer | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2012-12-30 14:43:00 +0200 |
commit | 96d49bf04ce77c975fe500f4d961e4a1ffed4c26 (patch) | |
tree | 0e43958fb12f17b9dd7a3173ccf1123f4969e74e /doc/code/classes/Notes | |
parent | d075df56d3cfb15a5d11550d86229f5b8001fbe7 (diff) | |
download | gitlab-ce-96d49bf04ce77c975fe500f4d961e4a1ffed4c26.tar.gz |
Use sdoc to generate application code documentation
Diffstat (limited to 'doc/code/classes/Notes')
-rw-r--r-- | doc/code/classes/Notes/CreateContext.html | 136 | ||||
-rw-r--r-- | doc/code/classes/Notes/LoadContext.html | 157 |
2 files changed, 293 insertions, 0 deletions
diff --git a/doc/code/classes/Notes/CreateContext.html b/doc/code/classes/Notes/CreateContext.html new file mode 100644 index 00000000000..adb3a46fab5 --- /dev/null +++ b/doc/code/classes/Notes/CreateContext.html @@ -0,0 +1,136 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>Notes::CreateContext</title> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <link rel="stylesheet" href="../../css/reset.css" type="text/css" media="screen" /> +<link rel="stylesheet" href="../../css/main.css" type="text/css" media="screen" /> +<link rel="stylesheet" href="../../css/github.css" type="text/css" media="screen" /> +<script src="../../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script> +<script src="../../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script> +<script src="../../js/main.js" type="text/javascript" charset="utf-8"></script> +<script src="../../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script> + +</head> + +<body> + <div class="banner"> + + <h1> + <span class="type">Class</span> + Notes::CreateContext + + <span class="parent">< + + <a href="../BaseContext.html">BaseContext</a> + + </span> + + </h1> + <ul class="files"> + + <li><a href="../../files/app/contexts/notes/create_context_rb.html">app/contexts/notes/create_context.rb</a></li> + + </ul> + </div> + <div id="bodyContent"> + <div id="content"> + + + + + + + + + + + + + + + <!-- Method ref --> + <div class="sectiontitle">Methods</div> + <dl class="methods"> + + <dt>E</dt> + <dd> + <ul> + + + <li> + <a href="#method-i-execute">execute</a> + </li> + + </ul> + </dd> + + </dl> + + + + + + + + + + + + + + + + + + + <!-- Methods --> + + <div class="sectiontitle">Instance Public methods</div> + + <div class="method"> + <div class="title method-title" id="method-i-execute"> + + <b>execute</b>() + + <a href="../../classes/Notes/CreateContext.html#method-i-execute" name="method-i-execute" class="permalink">Link</a> + </div> + + + <div class="description"> + + </div> + + + + + + + <div class="sourcecode"> + + <p class="source-link"> + Source: + <a href="javascript:toggleSource('method-i-execute_source')" id="l_method-i-execute_source">show</a> + + </p> + <div id="method-i-execute_source" class="dyn-source"> + <pre><span class="ruby-comment"># File app/contexts/notes/create_context.rb, line 3</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">execute</span> + <span class="ruby-identifier">note</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">notes</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:note</span>]) + <span class="ruby-identifier">note</span>.<span class="ruby-identifier">author</span> = <span class="ruby-identifier">current_user</span> + <span class="ruby-identifier">note</span>.<span class="ruby-identifier">notify</span> = <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:notify</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'1'</span> + <span class="ruby-identifier">note</span>.<span class="ruby-identifier">notify_author</span> = <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:notify_author</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'1'</span> + <span class="ruby-identifier">note</span>.<span class="ruby-identifier">save</span> + <span class="ruby-identifier">note</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + </div> + </div> + + </div> + </body> +</html>
\ No newline at end of file diff --git a/doc/code/classes/Notes/LoadContext.html b/doc/code/classes/Notes/LoadContext.html new file mode 100644 index 00000000000..24731bc4e7d --- /dev/null +++ b/doc/code/classes/Notes/LoadContext.html @@ -0,0 +1,157 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>Notes::LoadContext</title> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <link rel="stylesheet" href="../../css/reset.css" type="text/css" media="screen" /> +<link rel="stylesheet" href="../../css/main.css" type="text/css" media="screen" /> +<link rel="stylesheet" href="../../css/github.css" type="text/css" media="screen" /> +<script src="../../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script> +<script src="../../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script> +<script src="../../js/main.js" type="text/javascript" charset="utf-8"></script> +<script src="../../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script> + +</head> + +<body> + <div class="banner"> + + <h1> + <span class="type">Class</span> + Notes::LoadContext + + <span class="parent">< + + <a href="../BaseContext.html">BaseContext</a> + + </span> + + </h1> + <ul class="files"> + + <li><a href="../../files/app/contexts/notes/load_context_rb.html">app/contexts/notes/load_context.rb</a></li> + + </ul> + </div> + <div id="bodyContent"> + <div id="content"> + + + + + + + + + + + + + + + <!-- Method ref --> + <div class="sectiontitle">Methods</div> + <dl class="methods"> + + <dt>E</dt> + <dd> + <ul> + + + <li> + <a href="#method-i-execute">execute</a> + </li> + + </ul> + </dd> + + </dl> + + + + + + + + + + + + + + + + + + + <!-- Methods --> + + <div class="sectiontitle">Instance Public methods</div> + + <div class="method"> + <div class="title method-title" id="method-i-execute"> + + <b>execute</b>() + + <a href="../../classes/Notes/LoadContext.html#method-i-execute" name="method-i-execute" class="permalink">Link</a> + </div> + + + <div class="description"> + + </div> + + + + + + + <div class="sourcecode"> + + <p class="source-link"> + Source: + <a href="javascript:toggleSource('method-i-execute_source')" id="l_method-i-execute_source">show</a> + + </p> + <div id="method-i-execute_source" class="dyn-source"> + <pre><span class="ruby-comment"># File app/contexts/notes/load_context.rb, line 3</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">execute</span> + <span class="ruby-identifier">target_type</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:target_type</span>] + <span class="ruby-identifier">target_id</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:target_id</span>] + <span class="ruby-identifier">after_id</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:after_id</span>] + <span class="ruby-identifier">before_id</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:before_id</span>] + + + <span class="ruby-ivar">@notes</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">target_type</span> + <span class="ruby-keyword">when</span> <span class="ruby-string">"commit"</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit_notes</span>(<span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-identifier">target_id</span>)).<span class="ruby-identifier">fresh</span>.<span class="ruby-identifier">limit</span>(<span class="ruby-number">20</span>) + <span class="ruby-keyword">when</span> <span class="ruby-string">"issue"</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">issues</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">target_id</span>).<span class="ruby-identifier">notes</span>.<span class="ruby-identifier">inc_author</span>.<span class="ruby-identifier">fresh</span>.<span class="ruby-identifier">limit</span>(<span class="ruby-number">20</span>) + <span class="ruby-keyword">when</span> <span class="ruby-string">"merge_request"</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">merge_requests</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">target_id</span>).<span class="ruby-identifier">mr_and_commit_notes</span>.<span class="ruby-identifier">inc_author</span>.<span class="ruby-identifier">fresh</span>.<span class="ruby-identifier">limit</span>(<span class="ruby-number">20</span>) + <span class="ruby-keyword">when</span> <span class="ruby-string">"snippet"</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">snippets</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">target_id</span>).<span class="ruby-identifier">notes</span>.<span class="ruby-identifier">fresh</span> + <span class="ruby-keyword">when</span> <span class="ruby-string">"wall"</span> + <span class="ruby-comment"># this is the only case, where the order is DESC</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">common_notes</span>.<span class="ruby-identifier">order</span>(<span class="ruby-string">"created_at DESC, id DESC"</span>).<span class="ruby-identifier">limit</span>(<span class="ruby-number">50</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-ivar">@notes</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">after_id</span> + <span class="ruby-ivar">@notes</span>.<span class="ruby-identifier">where</span>(<span class="ruby-string">"id > ?"</span>, <span class="ruby-identifier">after_id</span>) + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">before_id</span> + <span class="ruby-ivar">@notes</span>.<span class="ruby-identifier">where</span>(<span class="ruby-string">"id < ?"</span>, <span class="ruby-identifier">before_id</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-ivar">@notes</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + </div> + </div> + + </div> + </body> +</html>
\ No newline at end of file |