docs

feathersui · May 8, 2019 · 03700df · 03700df
1 parent a014961
commit 03700df
Show file tree

Hide file tree

Showing 3 changed files with 141 additions and 0 deletions.
diff --git a/docs/ImportAll.hx b/docs/ImportAll.hx
@@ -0,0 +1,118 @@
+import haxe.macro.Context;
+import sys.FileSystem;
+
+// stolen from haxe/doc/ImportAll.hx
+class ImportAll {
+	static function isSysTarget() {
+		return Context.defined("neko") || Context.defined("php") || Context.defined("cpp") || Context.defined("java") || Context.defined("python")
+			|| Context.defined("lua") || Context.defined("hl") || Context.defined("eval"); // TODO: have to add cs here, SPOD gets in the way at the moment
+	}
+
+	public static function run(?pack) {
+		if (pack == null) {
+			pack = "";
+			haxe.macro.Compiler.define("doc_gen");
+		}
+		if (Context.defined("interp")) {
+			haxe.macro.Compiler.define("macro");
+		}
+		switch (pack) {
+			case "php7":
+				if (!Context.defined("php7"))
+					return;
+			case "php":
+				if (!Context.defined("php"))
+					return;
+			case "neko":
+				if (!Context.defined("neko"))
+					return;
+			case "js":
+				if (!Context.defined("js"))
+					return;
+			case "cpp":
+				if (!Context.defined("cpp"))
+					return;
+			case "flash":
+				if (!Context.defined("flash9"))
+					return;
+			case "mt", "mtwin":
+				return;
+			case "sys":
+				if (!isSysTarget())
+					return;
+			case "java":
+				if (!Context.defined("java"))
+					return;
+			case "cs":
+				if (!Context.defined("cs"))
+					return;
+			case "python":
+				if (!Context.defined("python"))
+					return;
+			case "hl":
+				if (!Context.defined("hl"))
+					return;
+			case "lua":
+				if (!Context.defined("lua"))
+					return;
+			case "eval":
+				if (!Context.defined("eval"))
+					return;
+			case "ssl":
+				if (!Context.defined("neko") && !Context.defined("cpp"))
+					return;
+			case "tools", "build-tool":
+				return;
+		}
+		for (p in Context.getClassPath()) {
+			if (p == "/")
+				continue;
+			// skip if we have a classpath to haxe
+			if (pack.length == 0 && FileSystem.exists(p + "std"))
+				continue;
+			var p = p + pack.split(".").join("/");
+			if (StringTools.endsWith(p, "/"))
+				p = p.substr(0, -1);
+			if (!FileSystem.exists(p) || !FileSystem.isDirectory(p))
+				continue;
+			for (file in FileSystem.readDirectory(p)) {
+				if (file == ".svn" || file == "_std" || file == "src")
+					continue;
+				var full = (pack == "") ? file : pack + "." + file;
+				if (StringTools.endsWith(file, ".hx") && file.substr(0, file.length - 3).indexOf(".") < 0) {
+					var cl = full.substr(0, full.length - 3);
+					switch (cl) {
+						case "ImportAll", "neko.db.MacroManager":
+							continue;
+						case "haxe.TimerQueue":
+							if (Context.defined("neko") || Context.defined("php") || Context.defined("cpp"))
+								continue;
+						case "Sys":
+							if (!isSysTarget())
+								continue;
+						case "haxe.web.Request":
+							if (!(Context.defined("neko") || Context.defined("php") || Context.defined("js")))
+								continue;
+						case "haxe.macro.ExampleJSGenerator", "haxe.macro.Context", "haxe.macro.Compiler":
+							if (!Context.defined("eval"))
+								continue;
+						case "haxe.remoting.SocketWrapper":
+							if (!Context.defined("flash"))
+								continue;
+						case "haxe.remoting.SyncSocketConnection":
+							if (!(Context.defined("neko") || Context.defined("php") || Context.defined("cpp")))
+								continue;
+						case "neko.vm.Ui" | "sys.db.Sqlite" | "sys.db.Mysql" if (Context.defined("interp")):
+							continue;
+						case "sys.db.Sqlite" | "sys.db.Mysql" | "cs.db.AdoNet" if (Context.defined("cs")):
+							continue;
+						case "haxe.PythonSyntax" | "haxe.PythonInternal":
+							continue; // temp hack (https://github.com/HaxeFoundation/haxe/issues/3321)
+					}
+					Context.getModule(cl);
+				} else if (FileSystem.isDirectory(p + "/" + file))
+					run(full);
+			}
+		}
+	}
+}
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,9 @@
+# feathersui-openfl API documentation
+
+Automated tests created with [dox](https://github.com/HaxeFoundation/dox).
+
+To build API docs, use the following command:
+
+```sh
+haxe docs.hxml
+```
diff --git a/docs/docs.hxml b/docs/docs.hxml
@@ -0,0 +1,14 @@
+-cp ../src
+-D doc-gen
+-D display
+-lib lime
+-lib openfl
+-lib actuate
+--remap flash:openfl
+--macro ImportAll.run("feathers")
+--no-output
+--interp
+-xml ../build/xml/feathers.xml
+
+--next
+-cmd haxelib run dox -o ../build/api -i ../build/xml -in feathers --title "API Reference" -D website "https://feathersui.com" -D textColor 0x777777 --toplevel-package feathers