[prev in list] [next in list] [prev in thread] [next in thread] 

List:       osflash-sandy
Subject:    [Sandy] Sandy 3.0 Documentation effort - take 2
From:       petit () petitpub ! com (Petit)
Date:       2007-08-26 23:10:53
Message-ID: 46D2087D.7060304 () petitpub ! com
[Download RAW message or body]

Erratum:
"I will be testing this, but I'd like to to check the doc and tell me 
about errors."
Should read:

I will be testing this, but I'd like *you* to check the doc and tell me about errors.
:P

Petit wrote:
> Looking back now at the documentation of the ATransformable class, I 
> think there may be some errors.
> This is especially in regard to what coordinate system ( reference frame 
> ) different rotations are performed in.
> I believe I state "global" or "world" in some places where it should 
> really be "in the frame of its parent".
>
> I will be testing this, but I'd like to to check the doc and tell me 
> about errors.
> The highly flexlibel ATransformable class used for all kinds of 
> movements for the transform groups,
> the 3D objects and the camera, is important for all animations in Sandy.
> Making the documentation for this class as clear as possible, means 
> saving lots of hours for Sandy programmers.
>
> Most of the docs are now ready in a preliminary version 
> <http://petitpub.com/labs/media/flash/sandy3/docs/>.
> The events and commands packages are still up for grabbing.
> There's quite a few ToDo tags in the docs, which will be dealt with ( 
> Thomas )
>
> Greets!
> /Petit
>
> Petit wrote:
>   
>> Hi all!
>> Commented the sandy.math package and committed!
>> I also standardized parameter names - be warned!
>> If you find new bugs, please scream!
>>
>> I didn't dare to standardize names in the Matrix4Math class - to many 
>> risks and maybe too much laziness on my part ;)
>> Some ToDo points were we need better explanations.
>>
>> Also I don't really get why some classes containing only static methods 
>> should be instantiated as singletons.
>> Do we need instances to use class methods?
>> /P
>>
>> Petit wrote:
>>     
>>> Hi all!
>>>
>>> I have just concluded the first doc comment revision of the primitive 
>>> package and comitted.
>>> Until we get a more official site for the API documentation, you can 
>>> find it here:
>>> http://www.petitpub.com/labs/media/flash/sandy3/docs/
>>>
>>> Take a look and find the errors!
>>>
>>> Don't forget to pick a package to doc comment, if you please.
>>> @ http://www.flashsandy.org/wiki/pick_a_package_to_document_here
>>> I've already grabbed the sandy.core and sandy.core.scenegraph packages,
>>> the first of which is really easy ;)
>>>
>>> 4 now :P
>>> kiroukou wrote
>>>       
>>>> Jsut a word to say that you've done an AMAZING job so far!!!
>>>> http://www.flashsandy.org/wiki/asdoc  Please everybody have a look!
>>>>
>>>> It is perfect!!
>>>>
>>>> Thanks a lot Bertil, this is a really nice and complete contributuin  
>>>> you've done.
>>>>
>>>> Thomas
>>>>
>>>> Le 28 juil. 07 ? 02:26, Petit a ?crit :    
>>>>         
>>>>> Hi all!
>>>>>
>>>>> I'm starting a new thread on the Sandy 3.0 documentation effort.
>>>>>
>>>>> I have discussed with our lead developer Thomas on the matter of
>>>>> parameter naming.
>>>>> It is clear that there is already a convention for Sandy, using
>>>>> Hungarian notation for parameters and variables,
>>>>> encoding scope and data type, for example p_sName, identifies a
>>>>> parameter of type String.
>>>>> Here: http://www.flashsandy.org/developers/code_rules
>>>>>
>>>>> For consistency one can stand a little difficulty in pronunciation ;)
>>>>> So from now on it we follow the Sandy naming convention.
>>>>> However, it would be nice if we give method parameters self  
>>>>> documenting
>>>>> names.
>>>>> I have now changed my example documentation for the Box class  
>>>>> accordingly:
>>>>> http://www.petitpub.com/labs/media/flash/sandy3/docs/sandy/ 
>>>>> primitive/Box.html
>>>>>
>>>>> I have worked hard all day to create a doc commenting instruction,  
>>>>> which
>>>>> I will place at the Sandy wiki soon.
>>>>>
>>>>> Cheers!
>>>>> Petit
>>>>>           


[prev in list] [next in list] [prev in thread] [next in thread]