FLUID-4160: Improve commenting and documentation for core framework

Metadata

Source
FLUID-4160
Type
Improvement
Priority
Major
Status
Closed
Resolution
Fixed
Assignee
Antranig Basman
Reporter
Antranig Basman
Created
2011-03-25T00:20:26.617-0400
Updated
2014-03-03T13:12:08.226-0500
Versions
N/A
Fixed Versions
  1. 1.4
Component
  1. Framework

Description

As part of the "Documentation Sprint" underway, it is a good time to reassess the state of commenting and documentation for core functions. Functions with unclear motivation and especially those which are not intended to be part of the public framework API should be clearly marked, and documentation for many completely new framework features (IoC, "event boiling", "grades", renderer components etc.) is required.