Jassdoc Feedback

Scripts

6 years
edited 6 years
Hello My dear WC3 community:

Here's the topic to give feedback & suggestions about the Jass Documentation Reforged.

What's this?

Well, it's an updated database of ALL the functions that comes in WC3 reforged (1.32 +). Here you can find all the types, functions and variables available in WC3.

If you submit a JASS, ZINC (and LUA) code in this site, ALL THE code will offer a proper highlight with links to the natives. An example is good to go:
Code (jass) Select
1
private function Conditions takes nothing returns boolean
2
    return GetSpellAbilityId() == 'A000'
3
endfunction
4
5
private function Actions takes nothing returns nothing
6
    // your stuff...
7
endfunction
8
9
private function init takes nothing returns nothing
10
    local trigger t = RegisterAnyUnitEvent(EVENT_PLAYER_UNIT_SPELL_CAST, function Conditions, function Actions)
11
endfunction

From this 
07/07/2020: JassDoc Was born!!!!
4 years
For Lua maps there's a luahelper.lua file embedded in the game's executable. How should these functions be added to Jassdoc? What about standard Lua functions, while most of them don't need a description (just a link to the official manual) some were removed and are inaccessible. For example the io library.

Luahelper has these: __jarray, math.randomseed and math.random (changed), print (changed), FourCC, _DEBUG (variable), globals (I don't know yet what it does or when it appears)
4 years
Quote from: City17 on February 22, 2022, 02:11:16 PM
For Lua maps there's a luahelper.lua file embedded in the game's executable. How should these functions be added to Jassdoc? What about standard Lua functions, while most of them don't need a description (just a link to the official manual) some were removed and are inaccessible. For example the io library.

Luahelper has these: __jarray, math.randomseed and math.random (changed), print (changed), FourCC, _DEBUG (variable), globals (I don't know yet what it does or when it appears)
Hi!!

Well, we should work on that. I'm going to dig into the file and we could work in a way to add those functions inside the documentation.