Use sdoc to generate application code documentation

This commit is contained in:
Dmitriy Zaporozhets 2012-12-30 14:43:00 +02:00
parent d075df56d3
commit 96d49bf04c
589 changed files with 75674 additions and 99966 deletions

129
doc/code/css/github.css Normal file
View file

@ -0,0 +1,129 @@
/*
github.com style (c) Vasily Polovnyov <vast@whiteants.net>
*/
pre code {
display: block; padding: 0.5em;
color: #000;
background: #f8f8ff
}
pre .comment,
pre .template_comment,
pre .diff .header,
pre .javadoc {
color: #998;
font-style: italic
}
pre .keyword,
pre .css .rule .keyword,
pre .winutils,
pre .javascript .title,
pre .lisp .title,
pre .subst {
color: #000;
font-weight: bold
}
pre .number,
pre .hexcolor {
color: #40a070
}
pre .string,
pre .tag .value,
pre .phpdoc,
pre .tex .formula {
color: #d14
}
pre .title,
pre .id {
color: #900;
font-weight: bold
}
pre .javascript .title,
pre .lisp .title,
pre .subst {
font-weight: normal
}
pre .class .title,
pre .haskell .label,
pre .tex .command {
color: #458;
font-weight: bold
}
pre .tag,
pre .tag .title,
pre .rules .property,
pre .django .tag .keyword {
color: #000080;
font-weight: normal
}
pre .attribute,
pre .variable,
pre .instancevar,
pre .lisp .body {
color: #008080
}
pre .regexp {
color: #009926
}
pre .class {
color: #458;
font-weight: bold
}
pre .symbol,
pre .ruby .symbol .string,
pre .ruby .symbol .keyword,
pre .ruby .symbol .keymethods,
pre .lisp .keyword,
pre .tex .special,
pre .input_number {
color: #990073
}
pre .builtin,
pre .built_in,
pre .lisp .title {
color: #0086b3
}
pre .preprocessor,
pre .pi,
pre .doctype,
pre .shebang,
pre .cdata {
color: #999;
font-weight: bold
}
pre .deletion {
background: #fdd
}
pre .addition {
background: #dfd
}
pre .diff .change {
background: #0086b3
}
pre .chunk {
color: #aaa
}
pre .tex .formula {
opacity: 0.5;
}

333
doc/code/css/main.css Executable file
View file

@ -0,0 +1,333 @@
body {
font-family: "Helvetica Neue", Arial, sans-serif;
background: #FFF;
color: #000;
margin: 0px;
font-size: 0.82em;
line-height: 1.25em;
}
a {
color: #00F;
text-decoration: none;
}
a:hover {
color: #333;
background: #FE8;
}
p {
margin-bottom: 1em;
}
h1 {
font-size: 2.1em;
font-weight: normal;
line-height: 1.2em;
margin: 1.4em 0 0.7em 0;
}
h2 {
font-size: 1.6em;
margin: 1.8em 0 0.8em 0;
font-weight: normal;
line-height: 1.2em;
}
h3 {
font-size: 1.4em;
color:#555;
margin: 1.4em 0 0.7em 0;
font-weight: normal;
}
h4 {
margin: 1.4em 0 0.5em 0;
font-size: 1em;
}
table
{
margin-bottom: 1em;
}
td, th
{
padding: 0 0.7em 0.3em 0;
}
th
{
font-weight: bold;
}
.clear
{
clear: both;
width: 0; height: 0;
}
dt
{
margin-bottom: 0.3em;
font-weight: bold;
}
dd
{
margin-left: 2em;
margin-bottom: 1em;
}
dd p
{
margin-top: 0.6em;
}
li
{
margin: 0 0 0.5em 2em;
}
ul li
{
list-style: disc;
}
ol li
{
list-style: decimal;
}
.banner
{
background: #EDF3FE;
border-bottom: 1px solid #ccc;
padding: 1em 2em 0.5em 2em;
}
.banner h1
{
font-size: 1.2em;
margin: 0;
}
.banner h1 .type
{
font-size: 0.833em;
display:block;
}
.banner h1 .type,
.banner h1 .parent
{
color: #666;
}
.banner ul
{
margin-top: 0.3em;
margin-bottom: 0;
font-size: 0.85em;
}
.banner li
{
list-style: none;
margin-left: 0;
margin-bottom: 0;
}
pre
{
margin-bottom: 1em;
}
.methods dt
{
width: 1em;
font-size: 1.5em;
color:#AAA;
position: absolute;
font-weight: normal;
margin: 0;
}
.methods dd
{
margin-left: 2.5em;
min-height: 1.8em;
-height: 1.8em;
padding-bottom: 0.8em;
}
.methods ul li
{
margin-right: 0.7em;
margin-left: 0;
list-style: none;
display: inline;
}
#content {
margin: 2em;
margin-left: 3.5em;
margin-right: 3.5em;
}
.sectiontitle {
margin-top: 2em;
margin-bottom: 1.3em;
margin-left: -1.2em;
font-size: 1.2em;
padding: 0 0 0.25em 0;
font-weight: bold;
border-bottom: 1px solid #000;
}
.contenttitle {
margin-top: 4em;
margin-bottom: 1.3em;
margin-left: -0.9em;
font-size: 1.6em;
padding: 0 0 0.25em 0;
font-weight: bold;
}
.attr-rw {
padding-right: 1em;
text-align: center;
color: #055;
}
.attr-name {
font-weight: bold;
padding-right: 1em;
}
.attr-desc {
}
tt {
font-size: 1.15em;
}
.attr-value {
font-family: monospace;
padding-left: 1em;
font-size: 1.15em;
}
.dyn-source {
display: none;
background: #fffde8;
color: #000;
border: #ffe0bb dotted 1px;
margin: 0.5em 2em 0.5em 0;
padding: 0.5em;
}
.dyn-source .cmt {
color: #00F;
font-style: italic;
}
.dyn-source .kw {
color: #070;
font-weight: bold;
}
.description pre {
padding: 0.5em;
border: #ffe0bb dotted 1px;
background: #fffde8;
}
.method {
margin-bottom: 2em;
}
.method .description,
.method .sourcecode
{
margin-left: 1.2em;
}
.method h4
{
border-bottom: 1px dotted #999;
padding: 0 0 0.2em 0;
margin-bottom: 0.8em;
font-size: 1.1em;
color:#333;
}
.method .method-title {
border-bottom: 1px dotted #666;
padding: 0 0 0.15em 0;
margin: 0 0 0.5em 0;
font-size: 1.2em;
line-height: 1.25em;
position: relative;
}
.method .method-title a.permalink {
position: absolute;
font-size: 0.75em;
right: 0;
}
.method .sourcecode p.source-link {
text-indent: 0em;
margin-top: 0.5em;
}
.method .aka {
margin-top: 0.3em;
margin-left: 1em;
font-style: italic;
text-indent: 2em;
}
.method .source-link
{
font-size: 0.85em;
}
.ruby-constant {
color: teal;
}
.ruby-keyword {
color: #000;
font-weight: bold
}
.ruby-title {
color: #900;
font-weight: bold;
}
.ruby-ivar {
color: teal;
}
.ruby-operator {
color: #000;
font-weight: bold
}
.ruby-identifier {
color: #000;
}
.ruby-string,
.ruby-node {
color: #D14;
}
.ruby-comment {
color: #998;
font-style: italic;
}
.ruby-regexp {
color: #009926;
}
.ruby-value {
color: #990073;
}
.ruby-number {
color: #40A070;
}

384
doc/code/css/panel.css Executable file
View file

@ -0,0 +1,384 @@
/* Panel (begin) */
.panel
{
position: absolute;
width: 100%;
height: 100%;
top: 0;
left: 0;
background: #FFF;
z-index: 2;
font-family: "Helvetica Neue", "Arial", sans-serif;
//zoom: 1;
}
.panel_tree .results,
.panel_results .tree
{
display: none;
}
/* Header with search box (begin) */
.panel .header
{
width: 100%;
height: 29px;
border-bottom: 1px solid #666;
position: relative;
left: 0; top: 0;
background: #e8e8e8;
}
.panel .header div
{
margin: 0 7px;
}
.panel .header table
{
height: 29px;
width: 100%;
}
.panel .header table td
{
vertical-align: middle;
text-align: middle;
}
.panel .header label
{
position: absolute;
font-size: 12px;
line-height: 29px;
margin-left: 3px;
color: #999;
cursor: text;
}
.panel .header table input
{
width: 100%;
box-sizing: border-box;
-moz-box-sizing: border-box;
-webkit-box-sizing: border-box;
display: inline-block;
-webkit-appearance: searchfield;
height: 22px;
//height: auto;
}
/* Header with search box (end) */
/* Results (begin) */
.panel .result
{
position: absolute;
top: 30px;
bottom: 0;
left: 0;
width: 100%;
//height: expression((this.parentNode.offsetHeight - 31));
overflow-y: scroll;
overflow-x: hidden;
-overflow-y: hidden;
background: #EDF3FE url(../i/results_bg.png);
z-index: 2;
//zoom:1;
}
.panel .result ul
{
font-size: 0.8em;
width: 100%;
background: #EDF3FE url(../i/results_bg.png);
//zoom:1;
}
.panel .result ul li
{
height: 46px;
-height: 50px;
//display: inline;
//width: 100%;
//zoom: 1;
overflow: hidden;
padding: 4px 10px 0 10px;
cursor: pointer;
}
.panel .result ul li h1
{
font-size: 13px;
font-weight: normal;
color: #333;
margin-bottom: 2px;
white-space: nowrap;
}
.panel .result ul li p
{
font-size: 11px;
color: #333;
margin-bottom: 2px;
white-space: nowrap;
}
.panel .result ul li h1 i,
.panel .result ul li p.snippet
{
color: #999;
}
.panel .result ul li b
{
color: #000;
}
.panel .result ul li.current
{
background: #3875D7;
}
.panel .result ul li.current h1,
.panel .result ul li.current p
{
color: #DDD;
}
.panel .result ul li.current h1 i,
.panel .result ul li.current p.snippet
{
color: #AAA;
}
.panel .result ul li.current b
{
color: #FFF;
}
.panel .result ul li:hover,
.panel .result ul li.selected
{
background: #d0d0d0;
}
.panel .result ul li.current:hover
{
background: #2965C0;
}
.panel .result ul li .badge
{
margin-right: 0.4em;
margin-left: -0.2em;
padding: 0 0.2em;
color: #000;
border-radius: 3px;
}
.panel .result ul li .badge_1
{
background: #ACDBF4;
}
.panel .result ul li.current .badge_1
{
background: #97BFD7;
}
.panel .result ul li .badge_2
{
background: #ACF3C3;
}
.panel .result ul li.current .badge_2
{
background: #98D7AC;
}
.panel .result ul li .badge_3
{
background: #E0F3AC;
}
.panel .result ul li.current .badge_3
{
background: #C4D798;
}
.panel .result ul li .badge_4
{
background: #D7CA98;
}
.panel .result ul li.current .badge_4
{
background: #A6B0AC;
}
.panel .result ul li .badge_5
{
background: #F3C8AC;
}
.panel .result ul li.current .badge_5
{
background: #D7B198;
}
.panel .result ul li .badge_6
{
background: #F3ACC3;
}
.panel .result ul li.current .badge_6
{
background: #D798AB;
}
/* Results (end) */
/* Tree (begin) */ /**/
.panel .tree
{
position: absolute;
top: 30px;
bottom: 0;
left: 0;
width: 100%;
//zoom: 1;
//height: expression((this.parentNode.offsetHeight - 31));
overflow-y: scroll;
overflow-x: hidden;
-overflow-y: hidden;
background: #EDF3FE url(../i/tree_bg.png);
z-index: 30;
}
.panel .tree ul
{
background: #EDF3FE url(../i/tree_bg.png);
}
.panel .tree li
{
cursor: pointer;
overflow: hidden;
//height: 23px;
//display: inline;
//zoom: 1;
//width: 100%;
}
.panel .tree li .content
{
padding-left: 18px;
padding-top: 5px;
height: 18px;
overflow: hidden;
position: relative;
}
.panel .tree li .icon
{
width: 10px;
height: 9px;
background: url(../i/arrows.png);
background-position: 0 -9px;
position: absolute;
left: 1px;
top: 8px;
cursor: default;
}
.panel .tree li.closed .icon
{
background-position: 0 0;
}
.panel .tree ul li h1
{
font-size: 13px;
font-weight: normal;
color: #000;
margin-bottom: 2px;
white-space: nowrap;
}
.panel .tree ul li p
{
font-size: 11px;
color: #666;
margin-bottom: 2px;
white-space: nowrap;
}
.panel .tree ul li h1 i
{
color: #999;
font-style: normal;
}
.panel .tree ul li.empty
{
cursor: text;
}
.panel .tree ul li.empty h1,
.panel .tree ul li.empty p
{
color: #666;
font-style: italic;
}
.panel .tree ul li.current
{
background: #3875D7;
}
.panel .tree ul li.current .icon
{
background-position: -10px -9px;
}
.panel .tree ul li.current.closed .icon
{
background-position: -10px 0;
}
.panel .tree ul li.current h1
{
color: #FFF;
}
.panel .tree ul li.current p
{
color: #CCC;
}
.panel .tree ul li.current.empty h1,
.panel .tree ul li.current.empty p
{
color: #999;
}
.panel .tree ul li:hover
{
background: #d0d0d0;
}
.panel .tree ul li.current:hover
{
background: #2965C0;
}
.panel .tree .stopper
{
display: none;
}
/* Tree (end) */ /**/
/* Panel (end) */

48
doc/code/css/reset.css Executable file
View file

@ -0,0 +1,48 @@
/* http://meyerweb.com/eric/tools/css/reset/ */
/* v1.0 | 20080212 */
html, body, div, span, applet, object, iframe,
h1, h2, h3, h4, h5, h6, p, blockquote, pre,
a, abbr, acronym, address, big, cite, code,
del, dfn, em, font, img, ins, kbd, q, s, samp,
small, strike, strong, sub, sup, tt, var,
b, u, i, center,
dl, dt, dd, ol, ul, li,
fieldset, form, label, legend,
table, caption, tbody, tfoot, thead, tr, th, td {
margin: 0;
padding: 0;
border: 0;
outline: 0;
font-size: 100%;
vertical-align: baseline;
background: transparent;
}
body {
line-height: 1;
}
ol, ul {
list-style: none;
}
blockquote, q {
quotes: none;
}
blockquote:before, blockquote:after,
q:before, q:after {
content: '';
content: none;
}
/* remember to highlight inserts somehow! */
ins {
text-decoration: none;
}
del {
text-decoration: line-through;
}
/* tables still need 'cellspacing="0"' in the markup */
table {
border-collapse: collapse;
border-spacing: 0;
}