Permalink
Browse files

New styling for the API docs to bring them in line with the rest of t…

…he docs, yay
  • Loading branch information...
JarrettBillingsley committed Oct 18, 2014
1 parent 57b984f commit f79a0f2c778a611f8febbe0702a00856b85d415b
Showing with 249 additions and 13 deletions.
  1. +6 −6 docs/Doxyfile
  2. +155 −6 docs/crocstyle.css
  3. +22 −0 docs/footer.html
  4. +57 −0 docs/header.html
  5. +1 −1 src/croc/api/basic.cpp
  6. +8 −0 src/croc/mainpage.dox
View
@@ -58,7 +58,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = .
OUTPUT_DIRECTORY = ../../croc-pages/docs/api
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
@@ -1108,7 +1108,7 @@ HTML_FILE_EXTENSION = .html
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER =
HTML_HEADER = header.html
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1118,7 +1118,7 @@ HTML_HEADER =
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER =
HTML_FOOTER = footer.html
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
@@ -1162,15 +1162,15 @@ HTML_EXTRA_FILES =
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_HUE = 98
HTML_COLORSTYLE_HUE = 50
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
# in the HTML output. For a value of 0 the output will use grayscales only. A
# value of 255 will produce the most vivid colors.
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_SAT = 72
HTML_COLORSTYLE_SAT = 79
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100
@@ -1181,7 +1181,7 @@ HTML_COLORSTYLE_SAT = 72
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_GAMMA = 190
HTML_COLORSTYLE_GAMMA = 125
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting this
View
@@ -13,17 +13,75 @@ p
body
{
min-width: 780px;
max-width: 1260px;
font-family: Arial,Verdana,'Bitstream Vera Sans',Helvetica,sans-serif;
font-size: 13px;
color: #000;
width: 1018px;
margin-left: auto;
margin-right: auto;
background-color: #656565;
background-image: url('http://jfbillingsley.com/croc/chrome/site/backs.gif');
background-repeat: repeat-x;
}
h1, h2, h3, h4, h5, h6
{
margin-bottom: 2px;
}
h2.groupheader
{
border-bottom-color: black;
color: black;
}
hr
{
border-color: black;
}
div.header
{
background-image: none;
background-color: #E5E0CB;
border-bottom-color: black;
}
#navrow4
{
border-bottom: 1px solid black;
}
.mdescLeft, .mdescRight,
.memItemLeft, .memItemRight,
.memTemplItemLeft, .memTemplItemRight, .memTemplParams
{
background-color: #E5E0CB;
}
/* Style used for all hyperlinks. */
.contents a:visited
{
color: #6e9835;
}
:link, *:visited
{
color: #6e9835;
font-weight: bold;
border-bottom: 1px dotted #bbb;
text-decoration: none;
}
:link:hover, :visited:hover
{
background-color: #eee;
color: #555
}
a.code, a.code:visited, a.line, a.line:visited { color: #6e9835; border-bottom: none; text-decoration: underline; }
a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited { color: #6e9835; border-bottom: none; text-decoration: underline; }
.memname tr
{
float: left;
@@ -39,10 +97,55 @@ div.memproto
padding: 0px;
}
div.fragment
{
font-family: 'Consolas', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
border: dotted 1px #9c9;
background-color: #282828;
color: white;
padding: 4px 4px 4px 4px;
}
div.line
{
font-family: 'Consolas', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
line-height: 105%;
}
span.keyword { color: #FF3333 }
span.keywordtype { color: #FF3333 }
span.keywordflow { color: #FF3333 }
span.comment { color: #00A000 }
span.preprocessor { color: #FF3333 }
span.stringliteral { color: #FF7F00 }
span.charliteral { color: #FF7F00 }
pre.fragment
{
font-family: 'Consolas', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
background: #f7f7f7;
border: 1px solid #d7d7d7;
margin: 1em 1.75em;
padding: 0.25em;
overflow: auto;
}
code
{
font-family: 'Consolas', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
padding: 0em 0.1em;
margin: 0px;
background-color: #e5e0cb;
border-radius: 3px;
-webkit-border-radius: 3px;
-moz-border-radius: 3px;
}
.memdoc, dl.reflist dd
{
box-shadow: none;
background-image: none;
border: none;
}
.memproto, dl.reflist dt
@@ -51,22 +154,68 @@ div.memproto
background-image: none;
text-shadow: none;
font-family: monospace;
background-color: #E5E0CB;
border: none;
border-radius: 4px;
-webkit-border-radius: 4px;
-moz-border-radius: 4px;
}
.tabs, .tabs2, .tabs3
{
background-image: none;
background-color: #CEDEC4;
background-color: #E5E0CB;
}
.tablist li
{
background-image: none;
background-color: #CEDEC4;
background-color: #E5E0CB;
}
.navpath ul
{
background-image: none;
background-color: #CEDEC4;
}
background-color: #E5E0CB;
}
#titlearea
{
text-align: center;
padding: 10px 0px;
}
#container
{
background-color: #FFF;
padding: 0px 20px;
}
address.footer
{
padding-bottom: 10px;
}
table.params
{
border: 2px solid #CCC;
font-size: 13px;
border-collapse: collapse;
border-spacing: 0px;
border-collapse: collapse;
max-width: 800px;
}
table.params td
{
border: 1px solid grey;
padding: 3px 3px 3px 3px;
vertical-align: middle;
}
td.paramname
{
color: black;
background-color: #e5e0cb;
text-align: right;
}
View
@@ -0,0 +1,22 @@
<!-- HTML footer for doxygen 1.8.6-->
<!-- start footer part -->
<!--BEGIN GENERATE_TREEVIEW-->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
$navpath
<li class="footer">$generatedby
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
</ul>
</div>
<!--END GENERATE_TREEVIEW-->
<!--BEGIN !GENERATE_TREEVIEW-->
<hr class="footer"/><address class="footer"><small>
$generatedby &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
</a> $doxygenversion
</small></address>
<!--END !GENERATE_TREEVIEW-->
</div> <!-- container -->
</body>
</html>
View
@@ -0,0 +1,57 @@
<!-- HTML header for doxygen 1.8.6-->
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen $doxygenversion"/>
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="$relpath^jquery.js"></script>
<script type="text/javascript" src="$relpath^dynsections.js"></script>
$treeview
$search
$mathjax
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
$extrastylesheet
</head>
<body>
<div id="container">
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!--BEGIN TITLEAREA-->
<div id="titlearea">
<img src="http://jfbillingsley.com/croc/chrome/site/banner.gif" alt="The Croc Programming Language" />
<!-- <table cellspacing="0" cellpadding="0"> -->
<!-- <tbody> -->
<!-- <tr style="height: 56px;"> -->
<!--BEGIN PROJECT_LOGO-->
<!-- <td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td> -->
<!--END PROJECT_LOGO-->
<!--BEGIN PROJECT_NAME-->
<!-- <td style="padding-left: 0.5em;"> -->
<!-- <div id="projectname">$projectname -->
<!--BEGIN PROJECT_NUMBER--><!--&#160;<span id="projectnumber">$projectnumber</span>--><!--END PROJECT_NUMBER-->
<!-- </div> -->
<!--BEGIN PROJECT_BRIEF--><!--<div id="projectbrief">$projectbrief</div>--><!--END PROJECT_BRIEF-->
<!-- </td> -->
<!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME-->
<!--BEGIN PROJECT_BRIEF-->
<!-- <td style="padding-left: 0.5em;"> -->
<!-- <div id="projectbrief">$projectbrief</div> -->
<!-- </td> -->
<!--END PROJECT_BRIEF-->
<!--END !PROJECT_NAME-->
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN SEARCHENGINE-->
<!-- <td>$searchbox</td> -->
<!--END SEARCHENGINE-->
<!--END DISABLE_INDEX-->
<!-- </tr> -->
<!-- </tbody> -->
<!-- </table> -->
</div>
<!--END TITLEAREA-->
<!-- end header part -->
View
@@ -11,7 +11,7 @@ using namespace croc;
extern "C"
{
/** This, \ref croc_foreachNext, and \ref croc_foreachEnd are used together to perform the equivalent of the Croc
\c 'foreach; loop.
\c 'foreach' loop.
Here's how you use them:
View
@@ -0,0 +1,8 @@
/*!
\mainpage
\section Welcome
This is the documentation for the Croc native API. To get started, click the "API" button above to browse the docs by
section, or the "Globals" button to browse all API functions, types etc. by name.
*/

0 comments on commit f79a0f2

Please sign in to comment.