From 17747ad0e23c8213da3d5a550ade28baece33de0 Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Sat, 9 May 2015 01:55:27 -0700 Subject: [PATCH] Add some overview docs to compositing::constellation --- components/compositing/constellation.rs | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/components/compositing/constellation.rs b/components/compositing/constellation.rs index 8794c65662c9..24b581999860 100644 --- a/components/compositing/constellation.rs +++ b/components/compositing/constellation.rs @@ -2,6 +2,13 @@ * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ +//! The `Constellation`, Servo's Grand Central Station +//! +//! The primary duty of a `Constellation` is to mediate between the +//! graphics compositor and the many `Pipeline`s in the browser's +//! navigation context, each `Pipeline` encompassing a `ScriptTask`, +//! `LayoutTask`, and `PaintTask`. + use pipeline::{Pipeline, CompositionPipeline}; use compositor_task::CompositorProxy; @@ -44,6 +51,11 @@ use clipboard::ClipboardContext; use webdriver_traits::WebDriverScriptCommand; /// Maintains the pipelines and navigation context and grants permission to composite. +/// +/// It is parameterized over a `LayoutTaskFactory` and a +/// `ScriptTaskFactory` (which in practice are implemented by +/// `LayoutTask` in the `layout` crate, and `ScriptTask` in +/// the `script` crate). pub struct Constellation { /// A channel through which messages can be sent to this object. pub chan: ConstellationChan,