Re: [FreeJ] freej documentation

dyne.org open discussions
Author: MrGoil
Date:  
To: FreeJ mailinglist
Subject: Re: [FreeJ] freej documentation
frac tal schrieb:
> Greetings freej users + devs,
>
> I've recently discovered freej and have been enjoying learning how to
> use the program. However, the docs provided on the dyne site are a
> version or so behind the current version. Is there documentation for
> the current version?


Hi frac!

The docs on the site are freej-0.9.1. However, if you fetch freej source
via git, then

cd docs/scripting
make

this generates the documentation belonging to that version in ./html
(you must not compile freej to get the html doc because 'current' stuff
from git might just crash or not compile at all)

> I would be happy to contribute to the documentation, but of course I
> don't want to duplicate work that has already been completed.


Great! Actually I updated the wii controller docs. Looks like that:

http://git.dyne.org/index.cgi?url=freej/diff/doc/scripting/Controller.js&h=todo_script_cleanup&id=142a308918bc1cfe3a75a2645b1e6d469252f2ca

Generally the doc needs some reviewing, e.g. grep for f*ck ;)

There will be some greater changes in the API. The latest is in the
todo_script_cleanup branch.
Mh, can you read c++ code? The next topic for documentation are
Linklist() and Entry() which are in src/linklist_js.cpp and
src/include/linklist_js.h .

> cheers,
>
> f0


you are welcome!

MrGoil


> _______________________________________________
> Freej mailing list
> Freej@???
> http://lists.dyne.org/cgi-bin/mailman/listinfo/freej