Uploaded image for project: 'Fluid Infusion'
  1. Fluid Infusion
  2. FLUID-3881

Comment any "unsupported" functions/variables/etc.

    XMLWordPrintable

Details

    • Task
    • Status: Closed
    • Blocker
    • Resolution: Fixed
    • None
    • 1.3
    • Tech. Documentation
    • None

    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.

      Attachments

        1. FLUID-3881-Reorderer.patch
          3 kB
          Antranig Basman

        Activity

          People

            anastasia Anastasia Cheetham
            anastasia Anastasia Cheetham
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: