Permalink
Browse files

start codox docs

  • Loading branch information...
1 parent 79b9415 commit 39404b729364e32c68f79090156682ef581501e9 @drcode committed Jan 28, 2013
Showing with 309 additions and 0 deletions.
  1. +210 −0 doc/css/default.css
  2. +2 −0 doc/index.html
  3. +4 −0 doc/js/jquery.min.js
  4. +67 −0 doc/js/page_effects.js
  5. +20 −0 doc/text.txt
  6. +2 −0 doc/webfui.framework.macros.html
  7. +2 −0 doc/webfui.macros.html
  8. +1 −0 project.clj
  9. +1 −0 target/stale/dependencies
View
@@ -0,0 +1,210 @@
+body {
+ font-family: sans-serif;
+ font-size: 11pt;
+}
+
+pre, code {
+ font-family: Monaco, DejaVu Sans Mono, Consolas, monospace;
+ font-size: 9pt;
+}
+
+h2 {
+ font-weight: normal;
+ font-size: 18pt;
+ margin: 10px 0 0.4em 0;
+}
+
+#header, #content, .sidebar {
+ position: fixed;
+}
+
+#header {
+ top: 0;
+ left: 0;
+ right: 0;
+ height: 20px;
+ background: #444;
+ color: #fff;
+ padding: 5px;
+}
+
+#content {
+ top: 30px;
+ right: 0;
+ bottom: 0;
+ overflow: auto;
+ background: #fff;
+ color: #333;
+ padding: 0 1em;
+}
+
+.sidebar {
+ position: fixed;
+ top: 30px;
+ bottom: 0;
+ overflow: auto;
+}
+
+#namespaces {
+ background: #e6e6e6;
+ border-right: solid 1px #bbb;
+ left: 0;
+ width: 250px;
+}
+
+#vars {
+ background: #eeeeee;
+ border-right: solid 1px #ccc;
+ left: 251px;
+ width: 200px;
+}
+
+.namespace-index {
+ left: 251px;
+}
+
+.namespace-docs {
+ left: 452px;
+}
+
+#header {
+ background: -moz-linear-gradient(top, #555 0%, #222 100%);
+ background: -webkit-linear-gradient(top, #555 0%, #333 100%);
+ background: -o-linear-gradient(top, #555 0%, #222 100%);
+ background: -ms-linear-gradient(top, #555 0%, #222 100%);
+ background: linear-gradient(top, #555 0%, #222 100%);
+ box-shadow: 0 0 10px #555;
+ z-index: 100;
+}
+
+#header h1 {
+ margin: 0;
+ padding: 0;
+ font-size: 12pt;
+ font-weight: normal;
+ text-shadow: -1px -1px 0px #333;
+}
+
+#header a, .sidebar a {
+ display: block;
+ text-decoration: none;
+}
+
+#header a {
+ color: #fff;
+}
+
+.sidebar a {
+ color: #333;
+}
+
+#header h2 {
+ float: right;
+ font-size: 9pt;
+ font-weight: normal;
+ width: 10em;
+ margin: 3px 0;
+ color: #bbb;
+}
+
+#header h2 a {
+ display: inline;
+}
+
+.sidebar h3 {
+ margin: 0;
+ padding: 10px 0.5em 0 0.5em;
+ font-size: 14pt;
+ font-weight: normal
+}
+
+.sidebar ul {
+ padding: 0.5em 0em;
+ margin: 0;
+}
+
+.sidebar li {
+ display: block;
+}
+
+.sidebar li a {
+ padding: 7px 10px;
+}
+
+#namespaces li.current a {
+ border-left: 3px solid #a33;
+ padding-left: 7px;
+ color: #a33;
+}
+
+#vars li.current a {
+ border-left: 3px solid #33a;
+ padding-left: 7px;
+ color: #33a;
+}
+
+#content h3 {
+ margin-bottom: 0.5em;
+ font-size: 13pt;
+ font-weight: bold;
+}
+
+.public h3, h4.macro {
+ margin: 0;
+ float: left;
+}
+
+.usage {
+ clear: both;
+}
+
+h4.macro {
+ font-variant: small-caps;
+ font-size: 13px;
+ font-weight: bold;
+ color: #717171;
+ margin-top: 3px;
+ margin-left: 10px;
+}
+
+.public {
+ margin-top: 1.5em;
+ margin-bottom: 2.0em;
+}
+
+.public:last-child {
+ margin-bottom: 20%;
+}
+
+.namespace:last-child {
+ margin-bottom: 10%;
+}
+
+.index {
+ padding: 0;
+}
+
+.index * {
+ display: inline;
+}
+
+.index li {
+ padding: 0 .5em;
+}
+
+.index ul {
+ padding-left: 0;
+}
+
+.usage code {
+ display: block;
+ color: #008;
+}
+
+.doc {
+ margin-bottom: .5em;
+}
+
+.src-link a {
+ font-size: 9pt;
+}
View
@@ -0,0 +1,2 @@
+<!DOCTYPE html>
+<html><head><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>Webfui 0.2.1 API documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Webfui 0.2.1 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li><a href="webfui.framework.macros.html"><span>webfui.framework.macros</span></a></li><li><a href="webfui.macros.html"><span>webfui.macros</span></a></li></ul></div><div class="namespace-index" id="content"><h2>Webfui 0.2.1 API documentation</h2><div class="doc">Alpha release of Webfui- All Webfui source included in this repository release under Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php)</div><div class="namespace"><h3><a href="webfui.framework.macros.html"><span>webfui.framework.macros</span></a></h3><pre class="doc"></pre><div class="index"><p>Public variables and functions:</p><ul></ul></div></div><div class="namespace"><h3><a href="webfui.macros.html"><span>webfui.macros</span></a></h3><pre class="doc"></pre><div class="index"><p>Public variables and functions:</p><ul></ul></div></div></div></body></html>
Oops, something went wrong.
@@ -0,0 +1,67 @@
+function visibleInParent(element) {
+ var position = $(element).position().top
+ return position > -50 && position < ($(element).offsetParent().height() - 50)
+}
+
+function hasFragment(link, fragment) {
+ return $(link).attr("href").indexOf("#" + fragment) != -1
+}
+
+function findLinkByFragment(elements, fragment) {
+ return $(elements).filter(function(i, e) { return hasFragment(e, fragment)}).first()
+}
+
+function setCurrentVarLink() {
+ $('#vars li').removeClass('current')
+ $('.public').
+ filter(function(index) { return visibleInParent(this) }).
+ each(function(index, element) {
+ findLinkByFragment("#vars a", element.id).
+ parent().
+ addClass('current')
+ })
+}
+
+var hasStorage = (function() { try { return localStorage.getItem } catch(e) {} }())
+
+function scrollPositionId(element) {
+ var directory = window.location.href.replace(/[^\/]+\.html$/, '')
+ return 'scroll::' + $(element).attr('id') + '::' + directory
+}
+
+function storeScrollPosition(element) {
+ if (!hasStorage) return;
+ localStorage.setItem(scrollPositionId(element) + "::x", $(element).scrollLeft())
+ localStorage.setItem(scrollPositionId(element) + "::y", $(element).scrollTop())
+}
+
+function recallScrollPosition(element) {
+ if (!hasStorage) return;
+ $(element).scrollLeft(localStorage.getItem(scrollPositionId(element) + "::x"))
+ $(element).scrollTop(localStorage.getItem(scrollPositionId(element) + "::y"))
+}
+
+function persistScrollPosition(element) {
+ recallScrollPosition(element)
+ $(element).scroll(function() { storeScrollPosition(element) })
+}
+
+function sidebarContentWidth(element) {
+ var widths = $(element).find('span').map(function() { return $(this).width() })
+ return Math.max.apply(Math, widths)
+}
+
+function resizeNamespaces() {
+ var width = sidebarContentWidth('#namespaces') + 40
+ $('#namespaces').css('width', width)
+ $('#vars, .namespace-index').css('left', width + 1)
+ $('.namespace-docs').css('left', $('#vars').width() + width + 2)
+}
+
+$(window).ready(resizeNamespaces)
+$(window).ready(setCurrentVarLink)
+$(window).ready(function() { persistScrollPosition('#namespaces')})
+$(window).ready(function() {
+ $('#content').scroll(setCurrentVarLink)
+ $(window).resize(setCurrentVarLink)
+})
View
@@ -0,0 +1,20 @@
+Merciless, Tyrannical Web Programming With WebFUI
+
+I'm sure all of you have had the following situation happen to you sometime in your past, in school: One of your "chummier" teachers chats with the class about a book report that has to be done for next week. At this point, since the teacher seems so friendly, some of your classmates start whining about how unfair the assignment is and how it's a waste of time. At this point, the teacher has had their authority challenged. Consequently, they take a step back from their chummyness and exlaim "Hey! This classroom isn't a Democracy! I'm in charge and I'm telling you the book report is due next week!"
+
+The same can be said of computer programs. No computer program is architected like a Democracy. Instead, I think anyone would agree that computer programs, in general, are structured like some sort of authoritarian state, with the law dictated from above. And who is the person at the top? Well, the programmer, of course!
+
+But let me take this idea further, and divide authoritarian governments into three main types:
+
+Banana Republics
+This is the most primitive type of authoritarian government. A Banana republic is basically just a step above anarchy. Here, the government maintains the rule of law, but enforcement is arbitrary and ineffective. If you live in a banana republic, your best course is ignore most laws but instead focus on doing watever it takes to escape the wrath of the rulers. You may need to brive them, lie to them, it doesn't matter. The only important thing is to escape their scrutiny and live to see another day. All of us have once written that were Banana Republics: A novice programmer will do "whatever it takes" in their code to solve a problem and will ignore all rules of prudent code design, since they do not yet know that these rules exist. When I now think of all the hackish Banana Republic software I created in Commodore 64 Basic back in elementary school it makes me hang my head in shame to this day.
+
+Marxist States
+The next main type of authoritarian government is the Marxist State. This is the "ideal" version of Communism envisioned by Marx. One of the big lessons of the 21st Century is that it is probably impossible to actually build such a state in the real world. In a Marxist State, almost all people are "workers" organized in loose collectives, everyone pitching in what they can to keep things running. Each worker has strong "workers rights" and enjoys equality and dignity. The government is very small and only gives occasional broad mandates to keep the country on the right track.
+Probably the closest thing mankind has ever created to a Marxist state are, in my opinion, large technology companies. At least in theory, a programmer at Google, Valve, or Facebook is equal in status with their coworkers, and has flexibility in their work, as long as it keeps the company moving forward. They are organized into loose teams, and every programmer has rights and responsibilities. The executive team interferes minimally, as long as all teams are moving in a fruitful direction.
+In the world of programming, I would argue that object-oriented programming is a similar model of a Marxist State: Every object is a worker and has well-defined rights and responsibilities. Their rights include the right to own private data in variables that others are not allowed to see or modify. Also, they have the right not to be bipassed willy-nilly: For instance, if an object is responsible for maintaining a file on the harddrive, it would be bad form for another part of the program to directly modify the file without
+
+
+WebFUI is transparent because everything is data
+In WebFUI, all functions are kept in a state of ignorance regarding the outside world
+In MVC, objects are given basic dignities, such as the right to refuse changes, the right to own private data
@@ -0,0 +1,2 @@
+<!DOCTYPE html>
+<html><head><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>webfui.framework.macros documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Webfui 0.2.1 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li class="current"><a href="webfui.framework.macros.html"><span>webfui.framework.macros</span></a></li><li><a href="webfui.macros.html"><span>webfui.macros</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul></ul></div><div class="namespace-docs" id="content"><h2>webfui.framework.macros documentation</h2><pre class="doc"></pre></div></body></html>
@@ -0,0 +1,2 @@
+<!DOCTYPE html>
+<html><head><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>webfui.macros documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Webfui 0.2.1 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li><a href="webfui.framework.macros.html"><span>webfui.framework.macros</span></a></li><li class="current"><a href="webfui.macros.html"><span>webfui.macros</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul></ul></div><div class="namespace-docs" id="content"><h2>webfui.macros documentation</h2><pre class="doc"></pre></div></body></html>
View
@@ -1,3 +1,4 @@
(defproject webfui "0.2.1"
:description "Alpha release of Webfui- All Webfui source included in this repository release under Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php)"
+ :dev-dependencies [[lein-autodoc "0.9.0"]]
:url "http://lisperati.com")
@@ -0,0 +1 @@
+([:dependencies [[codox/codox.core "0.6.4"]]])

0 comments on commit 39404b7

Please sign in to comment.