FLUID-5461: Review framework API source code comments and compare to wiki pages

Description

Review the source code comments for the framework API functions that we are linking to and compare to the existing wiki pages. Identify cases where there is significantly more information in the wiki pages than in the source code.

In these cases, we should convert the wiki page to markdown, add to infusion-docs, and link to the converted page from the source code.

Comments

• Simon Bates commented 2014-07-04T16:05:56.589-0400

  • fluid.defaults
  • https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/core/js/Fluid.js#L1519-L1539
  • http://wiki.fluidproject.org/display/docs/fluid.defaults
  • wiki page includes a description of the return value and an example
  • fluid.fetchResources
  • https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/core/js/FluidRequests.js#L24-L50
  • http://wiki.fluidproject.org/display/docs/fluid.fetchResources
  • wiki page contains a lot more information; more than would likely fit into a source code comment
  • fluid.formatMessage
  • https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/core/js/JavaProperties.js#L93-L115
  • http://wiki.fluidproject.org/display/docs/fluid.formatMessage
  • source code and wiki page are equivalent
  • fluid.invokeGlobalFunction
  • https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/core/js/Fluid.js#L930-L944
  • I could not find a wiki page for this function
  • fluid.messageResolver
  • https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/core/js/Fluid.js#L2441-L2475
  • http://wiki.fluidproject.org/display/docs/fluid.messageResolver
  • the source code comment is empty
  • the wiki page contains quite a lot of information; more than would likely fit into a source code comment
  • fluid.registerNamespace
  • https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/core/js/Fluid.js#L957-L966
  • http://wiki.fluidproject.org/display/docs/fluid.registerNamespace
  • the source code comment is empty
  • the wiki page content should be moved to the source code
  • fluid.render
  • https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/renderer/js/fluidRenderer.js#L1551-L1570
  • http://wiki.fluidproject.org/display/docs/fluid.render
  • wiki page contains a lot more information; more than would likely fit into a source code comment
  • fluid.renderer.createRendererSubcomponent
  • https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/renderer/js/RendererUtilities.js#L62-L100
  • http://wiki.fluidproject.org/display/docs/fluid.renderer.createRendererSubcomponent
  • the source code comment is empty
  • the wiki page contains quite a lot of information; more than would likely fit into a source code comment
  • fluid.renderer.selectorsToCutpoints
  • https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/renderer/js/RendererUtilities.js#L268-L285
  • http://wiki.fluidproject.org/display/docs/fluid.renderer.selectorsToCutpoints
  • the source code comment is empty
  • the wiki page documents the parameters, return value, and contains some examples
  • fluid.rendererComponent
  • https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/renderer/js/RendererUtilities.js#L139-L141
  • the source code comment is empty
  • I could not find a wiki page
  • fluid.reRender
  • https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/renderer/js/fluidRenderer.js#L1480-L1527
  • http://wiki.fluidproject.org/display/docs/fluid.reRender [empty]
  • wiki page exists but is empty
  • fluid.selfRender
  • https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/renderer/js/fluidRenderer.js#L1572-L1588
  • http://wiki.fluidproject.org/display/docs/fluid.selfRender
  • source code and wiki page are equivalent
  • fluid.viewComponent
  • https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/core/js/FluidView.js#L34-L36
  • the source code comment is empty
  • I could not find a wiki page