[Sugar-devel] [Karma] pls review jsdocs for Karma

[Felipe López Toledo]

hey man,

I have read the online docs, here is my feedback:

[ feature request ]
add collision support for file names repeated

[ question ]
how does the actual localization algorithm work?
I mean, is there a way to localize all the content with one line?
maybe, we could explain it in the docs

[ bug? ]
maybe, I'm wrong, but I think here is an error:
/docs/symbols/Karma.html
- ninja1.sword === "sword"
+ ninja1.weapon === "sword"

[ suggestion ]
/docs/symbols/Karma.karma.html
Karma.karma.locale
what is the default value?, I suggest "en"


[ request ]
/docs/symbols/Karma.kCanvas.html
please, delete "fps" property, atm it does not have any function.

[ suggestion ]
I have seen some examples with code an explanation, I suggest to add comment
characters (/* */)

example:

docs/symbols/Karma.karma.html
Karma.karma.rand(lower, upper)
var num = rand(0, 10);
- num could be 0, 1, 2, 3 ... or 10
+ //num could be 0, 1, 2, 3 ... or 10 <-----

[ ]
btw, I see there is no kimage, ksound and so on documentation, I think it
is  the problem with the JsDoc toolkit, right?

regards

2009/12/3 Bryan Berry <bryan at olenepal.org>

> argh! sorry I forgot the link
> http://karma.sugarlabs.org/docs/index.html
>
> 2009/12/3 Bryan Berry <bryan at olenepal.org>
>
> I have added examples but there is still work to be done. Please let me
>> know if it is hard to follow or if significant chunks are missing
>>
>> I haven't exactly figured out how to document methods like play() since
>> there isn't an object specific to it
>>
>> I also haven't documented the kCanvas with the makeChain function. I fear
>> that the makeChain function -- while truly a feat of metaprogramming and
>> closure manipulation -- may be too clever. It also may not save that much
>> typing since I will have to document each function anyways. Felipe what do
>> you think?
>>
>
>


-- 
Felipe López Toledo
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.sugarlabs.org/archive/sugar-devel/attachments/20091214/50dda7e1/attachment.htm