From f579907ae4e52e6e2c451d41916eff0e44c84787 Mon Sep 17 00:00:00 2001 From: Josh Tynjala Date: Tue, 3 Sep 2024 15:45:31 -0700 Subject: [PATCH] API docs script --- .gitignore | 3 ++ scripts/docs.hxml | 124 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 127 insertions(+) create mode 100644 scripts/docs.hxml diff --git a/.gitignore b/.gitignore index 4920dfc..3f063a6 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,4 @@ samples/*/Export +docs +scripts/xml +scripts/pages \ No newline at end of file diff --git a/scripts/docs.hxml b/scripts/docs.hxml new file mode 100644 index 0000000..938c267 --- /dev/null +++ b/scripts/docs.hxml @@ -0,0 +1,124 @@ +# Generate platform-specific XML for documentation output + +# -xml xml/Flash.xml +# -swf obj/docs +# -swf-version 17.0 +# -D display=usage +# -D doc_gen +# --macro include("box2D") +# -lib lime +# -lib openfl +# -cp ../ +# --no-output + +-xml xml/Flash.xml +-cpp obj/docs +-D display=usage +-D doc_gen +-D flash_doc_gen +-D nocffi +--macro include("box2D") +-lib lime +-lib openfl +-cp ../ +--no-output + +--next + +-xml xml/Windows.xml +-cpp obj/docs +-D display=usage +-D windows +-D doc_gen +-D nocffi +--macro include("box2D") +-lib lime +-lib openfl +-cp ../ +--no-output + +--next + +-xml xml/macOS.xml +-cpp obj/docs +-D display=usage +-D mac +-D doc_gen +-D nocffi +--macro include("box2D") +-lib lime +-lib openfl +-cp ../ +--no-output + +--next + +-xml xml/Linux.xml +-cpp obj/docs +-D display=usage +-D linux +-D doc_gen +-D nocffi +--macro include("box2D") +-lib lime +-lib openfl +-cp ../ +--no-output + +--next + +-xml xml/Neko.xml +-neko obj/docs +-D display=usage +-D doc_gen +-D nocffi +--macro include("box2D") +-lib lime +-lib openfl +-cp ../ +--no-output + +--next + +-xml xml/iOS.xml +-cpp obj/docs +-D display=usage +-D ios +-D doc_gen +-D nocffi +--macro include("box2D") +-lib lime +-lib openfl +-cp ../ +--no-output + +--next + +-xml xml/Android.xml +-cpp obj/docs +-D display=usage +-D android +-D doc_gen +-D nocffi +--macro include("box2D") +-lib lime +-lib openfl +-cp ../ +--no-output + +--next + +-xml xml/HTML5.xml +-js obj/docs +-D display=usage +-D html5 +-D doc_gen +--macro include("box2D") +-lib lime +-lib openfl +-cp ../ +--no-output + +--next + +-cmd haxelib run dox -o ../docs -i xml -in box2D --toplevel-package box2D -D version 2.7 -D website "http://www.openfl.org" -D source-path "https://github.com/openfl/box2d/tree/master/src/" --title "box2d API Reference" \ No newline at end of file