FLUID-3881: Comment any "unsupported" functions/variables/etc.

Metadata

Source
FLUID-3881
Type
Task
Priority
Blocker
Status
Closed
Resolution
Fixed
Assignee
Anastasia Cheetham
Reporter
Anastasia Cheetham
Created
2010-12-07T15:32:22.064-0500
Updated
2011-01-14T10:54:42.220-0500
Versions
N/A
Fixed Versions
  1. 1.3
Component
  1. Tech. Documentation

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.

Comments

  • Justin Obara commented 2010-12-07T15:38:02.872-0500

    "Bug Parade Infusion 1.3"

  • Anastasia Cheetham commented 2010-12-14T13:17:58.428-0500

    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.

  • Antranig Basman commented 2010-12-15T17:02:32.866-0500

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

  • Anastasia Cheetham commented 2010-12-16T09:40:57.226-0500

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