How to get/dump LÖVE documentation for use in IDE?

General discussion about LÖVE, Lua, game development, puns, and unicorns.
Post Reply
User avatar
Ratchet
Citizen
Posts: 67
Joined: Mon Apr 08, 2013 10:32 am

How to get/dump LÖVE documentation for use in IDE?

Post by Ratchet »

I'm currently working on a small IDE for LÖVE and I want to add quick help feature that shows information about a function. I already wrote a Lua script that dumps all stuff from the love table. But of cause I only got the names of functions etc.

What I need is a summary of the wiki entry for each function including
  • Name
  • Arguments
  • Return values
  • Description
  • Version
  • (Example)
If possible, all variants (overloaded functions) with all types of possible arguments

Code: Select all

        love.graphics.draw( drawable, x, y, r, sx, sy, ox, oy, kx, ky )
0.9.0 | love.graphics.draw( texture, quad, x, y, r, sx, sy, ox, oy, kx, ky )
11.0  | love.graphics.draw( drawable, transform )
11.0  | love.graphics.draw( texture, quad, transform )

Draws a Drawable object (an Image, Canvas, SpriteBatch, ParticleSystem, Mesh, Text object, or Video) on the screen with optional rotation, scaling and shearing.

Code: Select all

love.graphics.line( x1, y1, x2, y2, ... )
love.graphics.line( points )

Draws lines between points. 
And so on. Any ideas how to get that?
macOS 10.14 Mojave | LÖVE 11.2
User avatar
zorg
Party member
Posts: 3436
Joined: Thu Dec 13, 2012 2:55 pm
Location: Absurdistan, Hungary
Contact:

Re: How to get/dump LÖVE documentation for use in IDE?

Post by zorg »

Did you check this out yet? Maybe you could use it :3

https://github.com/love2d-community/love-api
Me and my stuff :3True Neutral Aspirant. Why, yes, i do indeed enjoy sarcastically correcting others when they make the most blatant of spelling mistakes. No bullying or trolling the innocent tho.
User avatar
Ratchet
Citizen
Posts: 67
Joined: Mon Apr 08, 2013 10:32 am

Re: How to get/dump LÖVE documentation for use in IDE?

Post by Ratchet »

Exactly what I need. Thanks
macOS 10.14 Mojave | LÖVE 11.2
Post Reply

Who is online

Users browsing this forum: No registered users and 61 guests