Skip to content

Commit

Permalink
+ updated README with more detailed instructions
Browse files Browse the repository at this point in the history
+ new description for global "love" field
o replaced "value" with "Variant"
  • Loading branch information
sirskunkalot committed Oct 19, 2017
1 parent 9617dc3 commit e8b15d6
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Probably the most important part of an Eclipse LDT Execution Environment is the

This utility creates all the files needed for a LOVE2D api.zip and puts them in api/, provided you feed it the definitions from https://github.com/love2d-community/love-api.

**This project currently seems to output the last definition for a function when imported in LDT.** Every variant gets exported, though. But metalua implementation in LDT only sets the last seen function as its spec.
**This project currently only outputs the last definition for a function when imported in LDT.** Every variant gets exported, though. But metalua implementation in LDT only sets the last seen function as its spec.

**Enum definitions aren't encoded.**

Expand All @@ -18,7 +18,7 @@ Obviously https://github.com/love2d-community/love-api is incredibly important,

## How to use

1. Grab https://github.com/love2d-community/love-api. This specific build is tested against https://github.com/love2d-community/love-api/tree/241ebb963bd951df7d7499cc21dc1a19bd22b963
1. Grab https://github.com/love2d-community/love-api. This build of love-api-to-ldt-luadoc is tested against https://github.com/love2d-community/love-api/tree/d8d9524e199411760f4e7230acc3563a1de69adb.

2. Checkout/download this repository (love-api-to-ldt-luadoc).

Expand Down
1 change: 1 addition & 0 deletions builtins/global.lua
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
-- @module global

------------------------------------------------------------------------------
-- Framework for making 2D games in the Lua programming language
-- @field[parent = #global] love#love love love module

------------------------------------------------------------------------------
Expand Down
5 changes: 3 additions & 2 deletions main.lua
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@ typeFQN["string"] = "#string"
typeFQN["table"] = "#table"
-- ... not the best, but what you gonna do ...
typeFQN["light userdata"] = "#table"
-- dunno! (love.physics.Body:getUserData())
typeFQN["value"] = ""
-- "value" changed to "Variant"
--typeFQN["value"] = ""
typeFQN["Variant"] = "love#Variant"
-- ... can't express these well at all.
typeFQN["function"] = "" -- LuaDoc expects the full function contract. We can't give it that.
typeFQN["mixed"] = "" -- this literally means 'whatever', so...
Expand Down

0 comments on commit e8b15d6

Please sign in to comment.