Skip to content

Commit

Permalink
API docs script
Browse files Browse the repository at this point in the history
  • Loading branch information
joshtynjala committed Sep 3, 2024
1 parent a425172 commit f579907
Show file tree
Hide file tree
Showing 2 changed files with 127 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
samples/*/Export
docs
scripts/xml
scripts/pages
124 changes: 124 additions & 0 deletions scripts/docs.hxml
Original file line number Diff line number Diff line change
@@ -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"

0 comments on commit f579907

Please sign in to comment.