Page 1 of 1

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

Posted: Thu Nov 22, 2018 1:44 pm
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?

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

Posted: Thu Nov 22, 2018 1:46 pm
by zorg
Did you check this out yet? Maybe you could use it :3

https://github.com/love2d-community/love-api

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

Posted: Thu Nov 22, 2018 2:52 pm
by Ratchet
Exactly what I need. Thanks