Added generated haXe class documentation

Using the chxdoc haxe project (haxelib install chxdoc), added auto-generated API documentation. To generate, run the builddocs.sh shell script (on linux or Mac)
boorik · Jun 27, 2011 · 26c0938 · 26c0938
1 parent 766dc25
commit 26c0938
Show file tree

Hide file tree

Showing 39 changed files with 6,622 additions and 0 deletions.
diff --git a/buildDocs.hxml b/buildDocs.hxml
@@ -0,0 +1,11 @@
+# haXe build file for class documentation
+#cpp
+-cp .
+-cpp out-cpp/Mac64
+--no-output
+-D HXCPP_MULTI_THREADED
+-D HXCPP_M64
+--remap neko:cpp
+-xml docs/cpp.xml
+org.zeromq.IncludeAll
+
diff --git a/builddocs.sh b/builddocs.sh
@@ -0,0 +1,8 @@
+#!/bin/bash
+
+echo "** Build documentation:"
+haxe buildDocs.hxml
+
+chxdoc -o docs --developer=false --includeOnly=org.zeromq.* docs/cpp.xml,cpp
+
+rm -r tmp
diff --git a/docs/all_classes.html b/docs/all_classes.html
@@ -0,0 +1,36 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/tr/html4/loose.dtd">
+<html>
+	<head>
+		<!-- Generated by chxdoc (build 606) on 2011-06-27 -->
+		<title>All Types Haxe Application</title>
+		<meta name="date" content="2011-06-27"/>
+		<meta name="keywords" content=""/>
+		<link href="stylesheet.css" type="text/css" rel="stylesheet"/>
+	</head>
+	<body>
+		<div id="types-frame">
+			<h1>All Types</h1>
+			<ul class="types">
+				<!--
+					 Typedefs are split into 2 different types here.
+					 Those that are typedefs to existing classes are
+					 called "alias", otherwise it is a "typedef"
+				-->
+				<li class="enum"><a href="types/org/zeromq/ErrorType.html" target="classFrame" title="ErrorType">ErrorType</a></li>
+						<li class="typedef"><a href="types/org/zeromq/PollResult.html" target="classFrame" title="PollResult">PollResult</a></li>
+						<li class="typedef"><a href="types/org/zeromq/PollSocketEventTuple.html" target="classFrame" title="PollSocketEventTuple">PollSocketEventTuple</a></li>
+						<li class="enum"><a href="types/org/zeromq/SendReceiveFlagType.html" target="classFrame" title="SendReceiveFlagType">SendReceiveFlagType</a></li>
+						<li class="enum"><a href="types/org/zeromq/SocketOptionsType.html" target="classFrame" title="SocketOptionsType">SocketOptionsType</a></li>
+						<li class="enum"><a href="types/org/zeromq/SocketType.html" target="classFrame" title="SocketType">SocketType</a></li>
+						<li class="class"><a href="types/org/zeromq/ZMQ.html" target="classFrame" title="ZMQ">ZMQ</a></li>
+						<li class="class"><a href="types/org/zeromq/ZMQContext.html" target="classFrame" title="ZMQContext">ZMQContext</a></li>
+						<li class="class"><a href="types/org/zeromq/ZMQException.html" target="classFrame" title="ZMQException">ZMQException</a></li>
+						<li class="typedef"><a href="types/org/zeromq/ZMQInt64Type.html" target="classFrame" title="ZMQInt64Type">ZMQInt64Type</a></li>
+						<li class="class"><a href="types/org/zeromq/ZMQPoller.html" target="classFrame" title="ZMQPoller">ZMQPoller</a></li>
+						<li class="class"><a href="types/org/zeromq/ZMQSocket.html" target="classFrame" title="ZMQSocket">ZMQSocket</a></li>
+						<li class="class"><a href="types/org/zeromq/remoting/ZMQConnection.html" target="classFrame" title="ZMQConnection">ZMQConnection</a></li>
+						<li class="class"><a href="types/org/zeromq/remoting/ZMQSocketProtocol.html" target="classFrame" title="ZMQSocketProtocol">ZMQSocketProtocol</a></li>
+					</ul>
+		</div>
+	</body>
+</html>
diff --git a/docs/all_packages.html b/docs/all_packages.html
@@ -0,0 +1,28 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/tr/html4/loose.dtd">
+<html>
+	<head>
+		<!-- Generated by chxdoc (build 606) on 2011-06-27 -->
+		<title>Packages List Haxe Application</title>
+		<meta name="date" content="2011-06-27"/>
+		<meta name="keywords" content=""/>
+		<link href="stylesheet.css" type="text/css" rel="stylesheet"/>
+	</head>
+	<body>
+		<div id="packages-frame">
+			<h1>Haxe Application</h1>
+			<h2>http://www.haxe.org/</h2>
+			<div id="packages-header">
+				<ul>
+					<li class="alltypes"><a href="all_classes.html" target="packageFrame">all types</a></li>
+					<li class="overview"><a href="overview.html" target="classFrame">overview</a></li>
+
+				</ul>
+			</div>
+			<ul class="packages">
+				<li><a href="packages/package.html" target="packageFrame">[root types]</a></li>
+						<li><a href="packages/org/zeromq/package.html" target="packageFrame">org.zeromq</a></li>
+						<li><a href="packages/org/zeromq/remoting/package.html" target="packageFrame">org.zeromq.remoting</a></li>
+					</ul>
+		</div>
+	</body>
+</html>
diff --git a/docs/chxdoc.js b/docs/chxdoc.js
@@ -0,0 +1,64 @@
+
+function showInherited(name, visibile) {
+	//if IE
+	// document.styleSheets[0].rules
+	var r = document.styleSheets[0].cssRules;
+	if(r == undefined) {
+		document.styleSheets[0].addRule(".hideInherited" + name, visibile ? "display:inline" : "display:none");
+		document.styleSheets[0].addRule(".showInherited" + name, visibile ? "display:none" : "display:inline");
+	}
+	else {
+		for (var i = 0; i < r.length; i++) {
+			if (r[i].selectorText == ".hideInherited" + name)
+				r[i].style.display = visibile ? "inline" : "none";
+			if (r[i].selectorText == ".showInherited" + name)
+				r[i].style.display = visibile ? "none" : "inline";
+		}
+	}
+
+	setCookie(
+		"showInherited" + name,
+		visibile ? "true" : "false",
+		10000,
+		"/",
+		document.location.domain);
+}
+
+function initShowInherited() {
+    showInherited("Var", getCookie("showInheritedVar") == "true");
+    showInherited("Method", getCookie("showInheritedMethod") == "true");
+}
+
+function setCookie(name, value, days, path, domain, secure) {
+	var endDate=new Date();
+	endDate.setDate(endDate.getDate() + days);
+
+	document.cookie =
+		name + "=" + escape(value) +
+		((days==null) ? "" : ";expires=" + endDate.toGMTString()) +
+        ((path) ? "; path=" + path : "") +
+        ((domain) ? "; domain=" + domain : "") +
+        ((secure) ? "; secure" : "");
+}
+
+function getCookie(name) {
+	if (document.cookie.length>0) {
+		begin=document.cookie.indexOf(name + "=");
+		if (begin != -1) {
+			begin = begin + name.length + 1;
+			end = document.cookie.indexOf(";",begin);
+			if(end==-1)
+				end=document.cookie.length;
+			return unescape(document.cookie.substring(begin,end));
+		}
+	}
+	return "";
+}
+
+function isIE() {
+	if(navigator.appName.indexOf("Microsoft") != -1)
+		return true;
+	return false;
+}
+
+initShowInherited();