Release task: Documenting "unsupported" APIs

Cheetham, Anastasia acheetham at ocad.ca
Thu Jul 7 14:43:32 UTC 2011


As part of our code clean-up for the release, we need to ensure that any public but unsupported functions are commented as such in the code:
	http://issues.fluidproject.org/browse/FLUID-4250

Since different people are familiar with different parts of the codebase, this is a task that everyone is going to have to help with. As you finish up the last of your JIRAs, please look at each of the public functions you're working with and consider whether or not it's something integrators should know about or not. If it's something that's not really intended for public use, or is likely to change, please add a comment to that effect. Antranig has been using
        // unsupported, NON-API function
in the framework, and that seems to work. Feel free to add more information, if appropriate.

Cindy:
Could you look over the UI Options and UI Enhancer code?

Harris:
Could you look at the Table of Contents and Tabs code?

Mike:
Could you take care of the Uploader code?

Antranig:
I know you've recently done a once-over on the framework and renderer code: Do you think it's in good shape now, or should you have one more go?

Thanks, everyone.

-- 
Anastasia Cheetham     Inclusive Design Research Centre
acheetham at ocad.ca            Inclusive Design Institute
                                        OCAD University



More information about the fluid-work mailing list