Initial API documentation

This commit is contained in:
Joshua Granick
2014-09-03 19:01:32 -07:00
parent 830b395439
commit b649f1528b
7 changed files with 235 additions and 5 deletions

3
.gitignore vendored
View File

@@ -16,3 +16,6 @@ project/winrt/shaders/
.idea/
*.iml
tools/run.n
haxedoc.xml
documentation/*.xml
documentation/pages*

View File

@@ -0,0 +1,94 @@
package;
import lime.app.Application;
import lime.app.Config;
import lime.app.Event;
import lime.app.Module;
import lime.app.Preloader;
import lime.audio.openal.AL;
import lime.audio.openal.ALC;
import lime.audio.openal.ALContext;
import lime.audio.openal.ALDevice;
import lime.audio.ALAudioContext;
import lime.audio.ALCAudioContext;
import lime.audio.AudioBuffer;
import lime.audio.AudioContext;
import lime.audio.AudioManager;
import lime.audio.AudioSource;
import lime.audio.FlashAudioContext;
import lime.audio.HTML5AudioContext;
import lime.audio.WebAudioContext;
import lime.graphics.opengl.GL;
import lime.graphics.opengl.GLActiveInfo;
import lime.graphics.opengl.GLBuffer;
import lime.graphics.opengl.GLContextAttributes;
import lime.graphics.opengl.GLFramebuffer;
import lime.graphics.opengl.GLObject;
import lime.graphics.opengl.GLProgram;
import lime.graphics.opengl.GLRenderbuffer;
import lime.graphics.opengl.GLShader;
import lime.graphics.opengl.GLShaderPrecisionFormat;
import lime.graphics.opengl.GLTexture;
import lime.graphics.opengl.GLUniformLocation;
import lime.graphics.utils.ImageCanvasUtil;
import lime.graphics.utils.ImageDataUtil;
import lime.graphics.CanvasRenderContext;
import lime.graphics.DOMRenderContext;
import lime.graphics.FlashRenderContext;
import lime.graphics.Font;
import lime.graphics.GLRenderContext;
import lime.graphics.Image;
import lime.graphics.ImageBuffer;
import lime.graphics.ImageType;
import lime.graphics.RenderContext;
import lime.graphics.Renderer;
//import lime.graphics.TextFormat;
import lime.math.ColorMatrix;
import lime.math.Matrix3;
import lime.math.Matrix4;
import lime.math.Rectangle;
import lime.math.Vector2;
import lime.math.Vector4;
import lime.net.curl.CURL;
import lime.net.curl.CURLCode;
import lime.net.curl.CURLEasy;
import lime.net.curl.CURLInfo;
import lime.net.curl.CURLOption;
import lime.net.curl.CURLVersion;
import lime.net.oauth.OAuthClient;
import lime.net.oauth.OAuthConsumer;
import lime.net.oauth.OAuthRequest;
import lime.net.oauth.OAuthSignatureMethod;
import lime.net.oauth.OAuthToken;
import lime.net.oauth.OAuthVersion;
//import lime.net.NetConnection;
//import lime.net.NetConnectionManager;
import lime.net.URIParser;
import lime.net.URLLoader;
import lime.net.URLLoaderDataFormat;
import lime.net.URLRequest;
import lime.net.URLRequestHeader;
import lime.net.URLRequestMethod;
import lime.net.URLVariables;
import lime.system.System;
import lime.ui.KeyCode;
import lime.ui.KeyEventManager;
import lime.ui.MouseEventManager;
import lime.ui.TouchEventManager;
import lime.ui.Window;
import lime.utils.ArrayBuffer;
import lime.utils.ArrayBufferView;
import lime.utils.ByteArray;
import lime.utils.Float32Array;
import lime.utils.GLUtils;
import lime.utils.IDataInput;
import lime.utils.IMemoryRange;
import lime.utils.Int16Array;
import lime.utils.Int32Array;
import lime.utils.Int8Array;
import lime.utils.UInt16Array;
import lime.utils.UInt32Array;
import lime.utils.UInt8Array;
//import lime.vm.NekoVM;
import lime.Assets;

124
documentation/build.hxml Normal file
View File

@@ -0,0 +1,124 @@
# Generate single haxedoc.xml for haxelib
-xml ../haxedoc.xml
-cpp obj/docs
-D display
ImportAll
-lib lime
--no-output
--next
# Generate platform-specific XML for documentation output
-xml Flash.xml
#-swf obj/docs
-cpp obj/docs
-D display
ImportAll
-lib lime
#-swf-version 11
--no-output
--next
-xml Windows.xml
-cpp obj/docs
-D display
-D native
-D windows
ImportAll
-lib lime
--no-output
--next
-xml Mac.xml
-cpp obj/docs
-D display
-D native
-D mac
ImportAll
-lib lime
--no-output
--next
-xml Linux.xml
-cpp obj/docs
-D display
-D native
-D linux
ImportAll
-lib lime
--no-output
#--next
#
#-xml iOS.xml
#-cpp obj/docs
#-D display
#-D native
#-D ios
#ImportAll
#-lib openfl
#--no-output
#
#--next
#
#-xml Android.xml
#-cpp obj/docs
#-D display
#-D native
#-D android
#ImportAll
#-lib lime
#--no-output
#
#--next
#
#-xml BlackBerry.xml
#-cpp obj/docs
#-D display
#-D native
#-D blackberry
#ImportAll
#-lib lime
#--no-output
#
#--next
#
#-xml Tizen.xml
#-cpp obj/docs
#-D display
#-D native
#-D tizen
#ImportAll
#-lib lime
#--no-output
#
#--next
#
#-xml Firefox OS.xml
#-cpp obj/docs
#-D display
#-D html5
#-D firefoxos
#ImportAll
#-lib lime
#--no-output
#
--next
-xml HTML5.xml
#-js obj/docs
-cpp obj/docs
-D display
-D html5
ImportAll
-lib lime
--no-output
--next
-cmd haxelib run dox -i . -in lime

View File

@@ -255,7 +255,13 @@ class Font {
}
public function loadGlyphs (size:Int, glyphs:String="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@#$%^`'\"/\\&*()[]{}<>|:;_-+=?,. ") {
public function loadGlyphs (size:Int, glyphs:String=null) {
if (glyphs == null) {
glyphs = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@#$%^`'\"/\\&*()[]{}<>|:;_-+=?,. ";
}
#if (flash || js)

View File

@@ -1,4 +1,4 @@
package lime.net.oauth; #if !flash
package lime.net.oauth;
import haxe.crypto.Base64;
@@ -26,7 +26,7 @@ class OAuthRequest {
this.version = version;
request = new URLRequest();
request.url = url;
request.method = method;
request.method = cast method;
this.parameters = parameters;
uri = new URIParser(url);
@@ -119,5 +119,6 @@ class OAuthRequest {
}
}
#end
typedef KVPair = {k:String, v:String};

View File

@@ -67,9 +67,11 @@ class System {
}
#if tools
ApplicationMain.config.background = color;
ApplicationMain.config.element = element;
ApplicationMain.create ();
#end
}
#end

View File

@@ -1,5 +1,5 @@
package lime.utils;
#if html5
#if js
typedef ArrayBufferView = js.html.ArrayBufferView;
#else