Documentation update

This commit is contained in:
Joshua Granick
2018-07-10 16:49:02 -07:00
parent ab1075c70a
commit 22965fa6f5
40 changed files with 220 additions and 111 deletions

View File

@@ -91,7 +91,7 @@
<define name="lime-cairo" unless="flash || html5" />
<define name="lime-curl" unless="lime-console || lime-switch || emscripten || flash || html5" />
<define name="lime-opengl" unless="lime-console || flash" />
<!-- <define name="lime-opengl" unless="lime-console || flash" /> -->
<define name="lime-openal" unless="lime-console || static_link || flash || html5" />
<define name="lime-openal" if="emscripten" />

View File

@@ -12,8 +12,6 @@ import lime.graphics.Image;
import lime.graphics.ImageBuffer;
import lime.math.Rectangle;
import lime.media.openal.ALAuxiliaryEffectSlot;
import lime.system.CFFI;
import lime.system.CFFIPointer;
import lime.utils.DataPointer;
#if hl
@@ -29,12 +27,22 @@ import lime.system.DisplayMode;
import lime.utils.ArrayBufferView;
#end
#if (!lime_doc_gen || lime_cffi)
import lime.system.CFFI;
import lime.system.CFFIPointer;
#end
#if cpp
import cpp.Float32;
#else
typedef Float32 = Float;
#end
#if (lime_doc_gen && !lime_cffi)
typedef CFFI = Dynamic;
typedef CFFIPointer = Dynamic;
#end
// #if hl
// typedef TNative_Application = hl.Abstract<"Application">;
// #end
@@ -44,7 +52,7 @@ typedef Float32 = Float;
@:noDebug
#end
#if !macro
#if (!macro && !lime_doc_gen)
@:build(lime.system.CFFI.build())
#end

View File

@@ -629,7 +629,9 @@ class Application extends Module {
if (__windows.length == 0) {
#if !lime_doc_gen
System.exit (0);
#end
}

View File

@@ -3,7 +3,6 @@ package lime.graphics.opengl; #if (!lime_doc_gen || lime_opengl || lime_opengles
import haxe.io.Bytes;
import haxe.Int64;
import lime.system.CFFIPointer;
import lime.utils.ArrayBufferView;
import lime.utils.ArrayBuffer;
import lime.utils.BytePointer;
@@ -11,8 +10,9 @@ import lime.utils.DataPointer;
import lime.utils.Float32Array;
import lime.utils.Int32Array;
#if (lime_cffi && lime_opengl && !macro)
#if (lime_cffi && (lime_opengl || lime_opengles) && !macro)
import lime._internal.backend.native.NativeCFFI;
import lime.system.CFFIPointer;
#end
@:allow(lime.ui.Window)
@@ -3332,7 +3332,7 @@ class GL {
private var id:Int;
private var ptr:CFFIPointer;
private var ptr:#if (lime_cffi && (lime_opengl || lime_opengles) && !macro) CFFIPointer #else Dynamic #end;
private var refs:Array<GLObject>;

View File

@@ -1,4 +1,4 @@
package lime.net.curl;
package lime.net.curl; #if (!lime_doc_gen || lime_curl)
import haxe.io.Bytes;
@@ -316,3 +316,6 @@ class CURL {
}
#end

View File

@@ -1,4 +1,4 @@
package lime.net.curl;
package lime.net.curl; #if (!lime_doc_gen || lime_curl)
@:enum abstract CURLCode(Int) from Int to Int from UInt to UInt {
@@ -99,3 +99,6 @@ package lime.net.curl;
//var LAST = 93;
}
#end

View File

@@ -1,4 +1,4 @@
package lime.net.curl;
package lime.net.curl; #if (!lime_doc_gen || lime_curl)
@:enum abstract CURLInfo(Int) from Int to Int from UInt to UInt {
@@ -61,3 +61,6 @@ package lime.net.curl;
var SCHEME = 0x100000 + 49;
}
#end

View File

@@ -1,4 +1,4 @@
package lime.net.curl;
package lime.net.curl; #if (!lime_doc_gen || lime_curl)
import lime._internal.backend.native.NativeCFFI;
@@ -138,3 +138,6 @@ class CURLMulti {
}
#end

View File

@@ -1,4 +1,4 @@
package lime.net.curl;
package lime.net.curl; #if (!lime_doc_gen || lime_curl)
@:enum abstract CURLMultiCode(Int) from Int to Int from UInt /*to UInt*/ {
@@ -32,3 +32,6 @@ package lime.net.curl;
//LAST
}
#end

View File

@@ -1,4 +1,4 @@
package lime.net.curl;
package lime.net.curl; #if (!lime_doc_gen || lime_curl)
class CURLMultiMessage {
@@ -17,3 +17,6 @@ class CURLMultiMessage {
}
#end

View File

@@ -1,4 +1,4 @@
package lime.net.curl;
package lime.net.curl; #if (!lime_doc_gen || lime_curl)
@:enum abstract CURLMultiOption(Int) from Int to Int from UInt to UInt {
@@ -53,3 +53,6 @@ package lime.net.curl;
var PUSHDATA = 10015;
}
#end

View File

@@ -1,4 +1,4 @@
package lime.net.curl;
package lime.net.curl; #if (!lime_doc_gen || lime_curl)
@:enum abstract CURLOption(Int) from Int to Int from UInt to UInt {
@@ -262,3 +262,6 @@ package lime.net.curl;
var MIMEPOST = 10269;
}
#end

View File

@@ -1,4 +1,4 @@
package lime.net.curl;
package lime.net.curl; #if (!lime_doc_gen || lime_curl)
@:enum abstract CURLVersion(Int) from Int to Int from UInt to UInt {
@@ -10,3 +10,6 @@ package lime.net.curl;
//var LAST = 4;
}
#end

View File

@@ -1,4 +1,4 @@
package lime.system;
package lime.system; #if (!lime_doc_gen || lime_cffi)
import lime._internal.macros.CFFIMacro;
@@ -496,3 +496,6 @@ class CFFI {
}
}
#end
#end

View File

@@ -1,4 +1,4 @@
package lime.system;
package lime.system; #if (!lime_doc_gen || lime_cffi)
import lime._internal.backend.native.NativeCFFI;
@@ -46,3 +46,6 @@ abstract CFFIPointer(Dynamic) from Dynamic to Dynamic {
}
#end

View File

@@ -1,4 +1,4 @@
package lime.system;
package lime.system; #if (!lime_doc_gen || lime_cffi)
import lime._internal.backend.native.NativeCFFI;
@@ -157,3 +157,6 @@ class FileWatcher {
}
#end

View File

@@ -1,4 +1,4 @@
package lime.system;
package lime.system; #if (!lime_doc_gen || android)
import lime._internal.backend.native.NativeCFFI;
@@ -367,3 +367,6 @@ class JNIMethod {
}
#end

View File

@@ -159,6 +159,7 @@ class System {
#end
#if (!lime_doc_gen || sys)
public static function exit (code:Int):Void {
#if ((sys || air) && !macro)
@@ -182,6 +183,7 @@ class System {
#end
}
#end
public static function getDisplay (id:Int):Display {
@@ -295,7 +297,7 @@ class System {
}
#if (!lime_doc_gen || lime_cffi)
public static inline function load (library:String, method:String, args:Int = 0, lazy:Bool = false):Dynamic {
#if !macro
@@ -305,6 +307,7 @@ class System {
#end
}
#end
public static function openFile (path:String):Void {

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
import lime._internal.backend.native.NativeCFFI;
@@ -19,3 +19,6 @@ class HB {
}
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
import lime._internal.backend.native.NativeCFFI;
@@ -113,3 +113,6 @@ abstract HBBlob(CFFIPointer) from CFFIPointer to CFFIPointer {
}
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
import lime._internal.backend.native.NativeCFFI;
@@ -440,3 +440,6 @@ abstract HBBuffer(CFFIPointer) from CFFIPointer to CFFIPointer {
}
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
@:enum abstract HBBufferClusterLevel(Int) from Int to Int {
@@ -9,3 +9,6 @@ package lime.text.harfbuzz;
public var DEFAULT = 0;
}
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
@:enum abstract HBBufferContentType(Int) from Int to Int {
@@ -8,3 +8,6 @@ package lime.text.harfbuzz;
public var GLYPHS = 2;
}
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
@:enum abstract HBBufferFlags(Int) from Int to Int {
@@ -9,3 +9,6 @@ package lime.text.harfbuzz;
public var PRESERVE_DEFAULT_IGNORABLES = 0x00000004;
}
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
@:enum abstract HBBufferSerializeFlags(Int) from Int to Int {
@@ -9,3 +9,6 @@ package lime.text.harfbuzz;
public var NO_GLYPH_NAMES = 0x00000004;
}
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
@:enum abstract HBBufferSerializeFormat(Int) from Int to Int {
@@ -19,3 +19,6 @@ package lime.text.harfbuzz;
//@:cffi private static function lime_hb_buffer_serialize_format_from_string (str:String, len:Int):Int;
//@:cffi private static function lime_hb_buffer_serialize_format_to_string (format:Int):CFFIPointer;
//@:cffi private static function lime_hb_buffer_serialize_list_formats ():CFFIPointer;
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
@:enum abstract HBDirection(Int) from Int to Int {
@@ -10,3 +10,6 @@ package lime.text.harfbuzz;
public var BTT = 7;
}
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
import lime._internal.backend.native.NativeCFFI;
@@ -56,3 +56,6 @@ abstract HBFTFont(HBFont) to HBFont from CFFIPointer to CFFIPointer {
}
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
import lime._internal.backend.native.NativeCFFI;
@@ -122,3 +122,6 @@ abstract HBFace(CFFIPointer) from CFFIPointer to CFFIPointer {
}
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
class HBFeature {
@@ -15,3 +15,6 @@ class HBFeature {
//@:cffi private static function lime_hb_feature_from_string (str:String):CFFIPointer;
//@:cffi private static function lime_hb_feature_to_string (feature:CFFIPointer):CFFIPointer;
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
import lime._internal.backend.native.NativeCFFI;
@@ -218,3 +218,6 @@ abstract HBFont(CFFIPointer) from CFFIPointer to CFFIPointer {
}
#end

View File

@@ -1,15 +1,17 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
class HBGlyphExtents {
public function new () {
/**
* ...
* @author Joshua Granick
*/
class HBGlyphExtents
{
public function new()
{
}
}
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
class HBGlyphInfo {
@@ -19,8 +19,4 @@ class HBGlyphInfo {
}
//hb_codepoint_t codepoint;
//hb_mask_t mask;
//uint32_t cluster;
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
class HBGlyphPosition {
@@ -20,7 +20,4 @@ class HBGlyphPosition {
}
//hb_position_t x_advance;
//hb_position_t y_advance;
//hb_position_t x_offset;
//hb_position_t y_offset;
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
import lime._internal.backend.native.NativeCFFI;
@@ -51,3 +51,6 @@ abstract HBLanguage(CFFIPointer) from CFFIPointer to CFFIPointer {
}
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
@:enum abstract HBMemoryMode(Int) from Int to Int {
@@ -9,3 +9,6 @@ package lime.text.harfbuzz;
public var READONLY_MAY_MAKE_WRITABLE = 3;
}
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
@:enum abstract HBScript(Int) from Int to Int {
@@ -144,3 +144,6 @@ package lime.text.harfbuzz;
public var INVALID = 0;
}
#end

View File

@@ -1,14 +1,12 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
class HBSegmentProperties {
public function new () {
/**
* ...
* @author Joshua Granick
*/
class HBSegmentProperties
{
public function new()
{
}
@@ -16,3 +14,6 @@ class HBSegmentProperties
//@:cffi private static function lime_hb_segment_properties_equal (a:CFFIPointer, b:CFFIPointer):Bool;
//@:cffi private static function lime_hb_segment_properties_hash (p:CFFIPointer):Int;
}
#end

View File

@@ -1,4 +1,4 @@
package lime.text.harfbuzz;
package lime.text.harfbuzz; #if (!lime_doc_gen || lime_harfbuzz)
import lime._internal.backend.native.NativeCFFI;
@@ -248,3 +248,6 @@ abstract HBSet(CFFIPointer) from CFFIPointer to CFFIPointer {
}
#end

View File

@@ -129,6 +129,7 @@ abstract DataPointer(DataPointerType) to DataPointerType {
}
#if !lime_doc_gen
@:from @:noCompletion public static function fromCFFIPointer (pointer:CFFIPointer):DataPointer {
#if (lime_cffi && !macro)
@@ -139,6 +140,7 @@ abstract DataPointer(DataPointerType) to DataPointerType {
#end
}
#end
public static function fromFile (path:String):DataPointer {
@@ -407,13 +409,21 @@ abstract DataPointer(DataPointerType) to DataPointerType {
@:noCompletion @:op(A == B) private static inline function equals (a:DataPointer, b:Int):Bool { return (a:Float) == b; }
@:noCompletion @:op(A == B) private static inline function equalsPointer (a:DataPointer, b:DataPointer):Bool { return (a:Float) == (b:Float); }
@:noCompletion @:op(A > B) private static inline function greaterThan (a:DataPointer, b:Int):Bool { return (a:Float) > b; }
#if !lime_doc_gen
@:noCompletion @:op(A > B) private static inline function greaterThanPointer (a:DataPointer, b:CFFIPointer):Bool { return (a:Float) > b; }
#end
@:noCompletion @:op(A >= B) private static inline function greaterThanOrEqual (a:DataPointer, b:Int):Bool { return (a:Float) >= b; }
#if !lime_doc_gen
@:noCompletion @:op(A >= B) private static inline function greaterThanOrEqualPointer (a:DataPointer, b:CFFIPointer):Bool { return (a:Float) >= b; }
#end
@:noCompletion @:op(A < B) private static inline function lessThan (a:DataPointer, b:Int):Bool { return (a:Float) < b; }
#if !lime_doc_gen
@:noCompletion @:op(A < B) private static inline function lessThanPointer (a:DataPointer, b:CFFIPointer):Bool { return (a:Float) < b; }
#end
@:noCompletion @:op(A <= B) private static inline function lessThanOrEqual (a:DataPointer, b:Int):Bool { return (a:Float) <= b; }
#if !lime_doc_gen
@:noCompletion @:op(A <= B) private static inline function lessThanOrEqualPointer (a:DataPointer, b:CFFIPointer):Bool { return (a:Float) <= b; }
#end
@:noCompletion @:op(A != B) private static inline function notEquals (a:DataPointer, b:Int):Bool { return (a:Float) != b; }
@:noCompletion @:op(A != B) private static inline function notEqualsPointer (a:DataPointer, b:DataPointer):Bool { return (a:Float) != (b:Float); }
@:noCompletion @:op(A + B) private static inline function plus (a:DataPointer, b:Int):DataPointer { return __withOffset (a, b); }