Comment any "unsupported" functions/variables/etc.

Description

Anything in our code that is "unsupported" (i.e. not meant for public use despite the fact that technically it is public) needs to be indicated as such in the comments in the code. This covers

a) public free functions i.e. functions in the public namespace, such as fluid.inlineEdit.foo()
b) methods and instance variables on an object returned by a creator function
c) options defined in a defaults block or otherwise processed in the code but not for public use
d) return values

Please a comment in the code mentioning that the method/function/option/argument/return value is unsupported, and perhaps an explanation of why.

Anything unsupported will not be publicly documented.

Environment

None

Attachments

1

Activity

Show:

Anastasia Cheetham December 16, 2010 at 2:40 PM

I've reviewed and committed Antrantig's Reorderer patch.

Antranig Basman December 15, 2010 at 10:02 PM

Attached is a patch which comments unsupported functions in webapp/components/reorderer

Anastasia Cheetham December 14, 2010 at 6:17 PM

Antranig reviewed a list of new framework and renderer functions, and identified the public vs unsupported ones. I've modified the comments in the code accordingly.

Justin Obara December 7, 2010 at 8:38 PM

"Bug Parade Infusion 1.3"

Fixed

Details

Assignee

Reporter

Fix versions

Priority

Created December 7, 2010 at 8:32 PM
Updated January 14, 2011 at 3:54 PM
Resolved December 14, 2010 at 7:53 PM

Flag notifications