Use sdoc to generate application code documentation
This commit is contained in:
Dmitriy Zaporozhets
parent
d075df56d3
commit
96d49bf04c
589 changed files with 75674 additions and 99966 deletions
294
doc/code/classes/Group.html
Normal file
294
doc/code/classes/Group.html
Normal file
|
|
@ -0,0 +1,294 @@
|
|||
<?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>Group</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>
|
||||
Group
|
||||
|
||||
<span class="parent"><
|
||||
|
||||
<a href="Namespace.html">Namespace</a>
|
||||
|
||||
</span>
|
||||
|
||||
</h1>
|
||||
<ul class="files">
|
||||
|
||||
<li><a href="../files/app/models/group_rb.html">app/models/group.rb</a></li>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
<div id="bodyContent">
|
||||
<div id="content">
|
||||
|
||||
<div class="description">
|
||||
|
||||
<h2 id="label-Schema+Information">Schema Information</h2>
|
||||
|
||||
<p>Table name: namespaces</p>
|
||||
|
||||
<pre>id :integer not null, primary key
|
||||
name :string(255) not null
|
||||
path :string(255) not null
|
||||
owner_id :integer not null
|
||||
created_at :datetime not null
|
||||
updated_at :datetime not null
|
||||
type :string(255)</pre>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- Method ref -->
|
||||
<div class="sectiontitle">Methods</div>
|
||||
<dl class="methods">
|
||||
|
||||
<dt>A</dt>
|
||||
<dd>
|
||||
<ul>
|
||||
|
||||
|
||||
<li>
|
||||
<a href="#method-i-add_users_to_project_teams">add_users_to_project_teams</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
<dt>H</dt>
|
||||
<dd>
|
||||
<ul>
|
||||
|
||||
|
||||
<li>
|
||||
<a href="#method-i-human_name">human_name</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
<dt>T</dt>
|
||||
<dd>
|
||||
<ul>
|
||||
|
||||
|
||||
<li>
|
||||
<a href="#method-i-truncate_teams">truncate_teams</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
<dt>U</dt>
|
||||
<dd>
|
||||
<ul>
|
||||
|
||||
|
||||
<li>
|
||||
<a href="#method-i-users">users</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- Methods -->
|
||||
|
||||
<div class="sectiontitle">Instance Public methods</div>
|
||||
|
||||
<div class="method">
|
||||
<div class="title method-title" id="method-i-add_users_to_project_teams">
|
||||
|
||||
<b>add_users_to_project_teams</b>(user_ids, project_access)
|
||||
|
||||
<a href="../classes/Group.html#method-i-add_users_to_project_teams" name="method-i-add_users_to_project_teams" class="permalink">Link</a>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="sourcecode">
|
||||
|
||||
<p class="source-link">
|
||||
Source:
|
||||
<a href="javascript:toggleSource('method-i-add_users_to_project_teams_source')" id="l_method-i-add_users_to_project_teams_source">show</a>
|
||||
|
||||
</p>
|
||||
<div id="method-i-add_users_to_project_teams_source" class="dyn-source">
|
||||
<pre><span class="ruby-comment"># File app/models/group.rb, line 15</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">add_users_to_project_teams</span>(<span class="ruby-identifier">user_ids</span>, <span class="ruby-identifier">project_access</span>)
|
||||
<span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">add_users_into_projects</span>(
|
||||
<span class="ruby-identifier">projects</span>.<span class="ruby-identifier">map</span>(&<span class="ruby-value">:id</span>),
|
||||
<span class="ruby-identifier">user_ids</span>,
|
||||
<span class="ruby-identifier">project_access</span>
|
||||
)
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<div class="title method-title" id="method-i-human_name">
|
||||
|
||||
<b>human_name</b>()
|
||||
|
||||
<a href="../classes/Group.html#method-i-human_name" name="method-i-human_name" class="permalink">Link</a>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="sourcecode">
|
||||
|
||||
<p class="source-link">
|
||||
Source:
|
||||
<a href="javascript:toggleSource('method-i-human_name_source')" id="l_method-i-human_name_source">show</a>
|
||||
|
||||
</p>
|
||||
<div id="method-i-human_name_source" class="dyn-source">
|
||||
<pre><span class="ruby-comment"># File app/models/group.rb, line 29</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">human_name</span>
|
||||
<span class="ruby-identifier">name</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<div class="title method-title" id="method-i-truncate_teams">
|
||||
|
||||
<b>truncate_teams</b>()
|
||||
|
||||
<a href="../classes/Group.html#method-i-truncate_teams" name="method-i-truncate_teams" class="permalink">Link</a>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="sourcecode">
|
||||
|
||||
<p class="source-link">
|
||||
Source:
|
||||
<a href="javascript:toggleSource('method-i-truncate_teams_source')" id="l_method-i-truncate_teams_source">show</a>
|
||||
|
||||
</p>
|
||||
<div id="method-i-truncate_teams_source" class="dyn-source">
|
||||
<pre><span class="ruby-comment"># File app/models/group.rb, line 33</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">truncate_teams</span>
|
||||
<span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">truncate_teams</span>(<span class="ruby-identifier">project_ids</span>)
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<div class="title method-title" id="method-i-users">
|
||||
|
||||
<b>users</b>()
|
||||
|
||||
<a href="../classes/Group.html#method-i-users" name="method-i-users" class="permalink">Link</a>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="sourcecode">
|
||||
|
||||
<p class="source-link">
|
||||
Source:
|
||||
<a href="javascript:toggleSource('method-i-users_source')" id="l_method-i-users_source">show</a>
|
||||
|
||||
</p>
|
||||
<div id="method-i-users_source" class="dyn-source">
|
||||
<pre><span class="ruby-comment"># File app/models/group.rb, line 23</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">users</span>
|
||||
<span class="ruby-identifier">users</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">joins</span>(<span class="ruby-value">:users_projects</span>).<span class="ruby-identifier">where</span>(<span class="ruby-identifier">users_projects</span><span class="ruby-operator">:</span> {<span class="ruby-identifier">project_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_ids</span>})
|
||||
<span class="ruby-identifier">users</span> = <span class="ruby-identifier">users</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">owner</span>
|
||||
<span class="ruby-identifier">users</span>.<span class="ruby-identifier">uniq</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue