Browse Source

Add comments to private members

Steven Silvester 9 years ago
parent
commit
d40b04e702
1 changed files with 12 additions and 0 deletions
  1. 12 0
      src/docmanager/index.ts

+ 12 - 0
src/docmanager/index.ts

@@ -915,21 +915,33 @@ namespace Private {
   export
   const openedSignal = new Signal<DocumentManager, Widget>();
 
+  /**
+   * An extended interface for a model factory and its options.
+   */
   export
   interface IModelFactoryEx extends IModelFactoryOptions {
     factory: IModelFactory;
   }
 
+  /**
+   * An extended interface for a widget factory and its options.
+   */
   export
   interface IWidgetFactoryEx extends IWidgetFactoryOptions {
     factory: IWidgetFactory<Widget>;
   }
 
+  /**
+   * The widget factory name used to create a widget.
+   */
   export
   const factoryProperty = new Property<Widget, string>({
     name: 'factory'
   });
 
+  /**
+   * The context id associated with a widget.
+   */
   export
   const contextProperty = new Property<Widget, string>({
     name: 'context'