Single line comments to describe files (helpful in LXR)

This commit is contained in:
dbaron%dbaron.org 2006-03-29 18:29:03 +00:00
parent 39f8751079
commit 0e88f73bc6
76 changed files with 279 additions and 0 deletions

View File

@ -34,6 +34,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* code for managing absolutely positioned children of a rendering
* object that is a containing block for them
*/
#include "nsCOMPtr.h"
#include "nsAbsoluteContainingBlock.h"
#include "nsContainerFrame.h"

View File

@ -34,6 +34,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* code for managing absolutely positioned children of a rendering
* object that is a containing block for them
*/
#ifndef nsAbsoluteContainingBlock_h___
#define nsAbsoluteContainingBlock_h___

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* derived class of nsBlockFrame; distinction barely relevant anymore */
#include "nsAreaFrame.h"
#include "nsBlockBandData.h"
#include "nsStyleContext.h"

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* derived class of nsBlockFrame; distinction barely relevant anymore */
#ifndef nsAreaFrame_h___
#define nsAreaFrame_h___

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering object for HTML <br> elements */
#include "nsCOMPtr.h"
#include "nsFrame.h"
#include "nsHTMLParts.h"

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* code for management of floats that implements space manager interfaces */
#include "nsCOMPtr.h"
#include "nsBlockBandData.h"
#include "nsIFrame.h"

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* code for management of floats that implements space manager interfaces */
#ifndef nsBlockBandData_h___
#define nsBlockBandData_h___

View File

@ -40,6 +40,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* rendering object for CSS display:block and display:list-item objects,
* also used inside table cells
*/
#include "nsCOMPtr.h"
#include "nsBlockFrame.h"
#include "nsBlockReflowContext.h"

View File

@ -35,6 +35,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* rendering object for CSS display:block and display:list-item objects,
* also used inside table cells
*/
#ifndef nsBlockFrame_h___
#define nsBlockFrame_h___

View File

@ -36,6 +36,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* class that a parent frame uses to reflow a block frame */
#include "nsBlockReflowContext.h"
#include "nsLineLayout.h"
#include "nsSpaceManager.h"

View File

@ -35,6 +35,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* class that a parent frame uses to reflow a block frame */
#ifndef nsBlockReflowContext_h___
#define nsBlockReflowContext_h___

View File

@ -39,6 +39,8 @@
*
* ***** END LICENSE BLOCK ***** */
/* state used in reflow of block frames */
#include "nsBlockReflowContext.h"
#include "nsBlockReflowState.h"
#include "nsBlockFrame.h"

View File

@ -38,6 +38,8 @@
*
* ***** END LICENSE BLOCK ***** */
/* state used in reflow of block frames */
#ifndef nsBlockReflowState_h__
#define nsBlockReflowState_h__

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering object for list-item bullets */
#include "nsCOMPtr.h"
#include "nsBulletFrame.h"
#include "nsHTMLAtoms.h"

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering object for list-item bullets */
#ifndef nsBulletFrame_h___
#define nsBulletFrame_h___

View File

@ -36,6 +36,8 @@
*
* ***** END LICENSE BLOCK ***** */
/* rendering object for css3 multi-column layout */
#include "nsHTMLContainerFrame.h"
#include "nsIContent.h"
#include "nsIFrame.h"

View File

@ -35,6 +35,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* base class #1 for rendering objects that have child lists */
#include "nsContainerFrame.h"
#include "nsIContent.h"
#include "nsIDocument.h"

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* base class #1 for rendering objects that have child lists */
#ifndef nsContainerFrame_h___
#define nsContainerFrame_h___

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering object for CSS :first-letter pseudo-element */
#include "nsCOMPtr.h"
#include "nsHTMLContainerFrame.h"
#include "nsPresContext.h"

View File

@ -38,6 +38,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* base class of all rendering objects */
#include "nsCOMPtr.h"
#include "nsFrame.h"
#include "nsFrameList.h"

View File

@ -35,6 +35,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* base class of all rendering objects */
#ifndef nsFrame_h___
#define nsFrame_h___

View File

@ -36,6 +36,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* rendering object for replaced elements that contain a document, such
* as <frame>, <iframe>, and some <object>s
*/
#include "nsCOMPtr.h"
#include "nsLeafFrame.h"
#include "nsGenericHTMLElement.h"

View File

@ -35,6 +35,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* class for maintaining a linked list of child frames */
#include "nsFrameList.h"
#ifdef NS_DEBUG
#include "nsIFrameDebug.h"

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* class for maintaining a linked list of child frames */
#ifndef nsFrameList_h___
#define nsFrameList_h___

View File

@ -35,6 +35,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering object for HTML <frameset> elements */
#include "nsCOMPtr.h"
#include "nsFrameSetFrame.h"
#include "nsContentUtils.h"

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering object for HTML <frameset> elements */
#ifndef nsHTMLFrameset_h___
#define nsHTMLFrameset_h___

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* utilities for regression tests based on frame tree comparison */
#include "nsIFrameUtil.h"
#include "nsFrame.h"
#include "nsString.h"

View File

@ -35,6 +35,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering object to wrap rendering objects that should be scrollable */
#include "nsCOMPtr.h"
#include "nsHTMLParts.h"
#include "nsPresContext.h"

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering object to wrap rendering objects that should be scrollable */
#ifndef nsGfxScrollFrame_h___
#define nsGfxScrollFrame_h___

View File

@ -36,6 +36,8 @@
*
* ***** END LICENSE BLOCK ***** */
/* rendering object for the HTML <canvas> element */
#include "nsHTMLParts.h"
#include "nsCOMPtr.h"
#include "nsIServiceManager.h"

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering object for the HTML <canvas> element */
#ifndef nsHTMLCanvasFrame_h___
#define nsHTMLCanvasFrame_h___

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* base class #2 for rendering objects that have child lists */
#include "nsHTMLContainerFrame.h"
#include "nsIRenderingContext.h"
#include "nsPresContext.h"

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* base class #2 for rendering objects that have child lists */
#ifndef nsHTMLContainerFrame_h___
#define nsHTMLContainerFrame_h___

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering object that goes directly inside the document's scrollbars */
#include "nsIServiceManager.h"
#include "nsHTMLParts.h"
#include "nsHTMLContainerFrame.h"

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* factory functions for rendering object classes */
#ifndef nsHTMLParts_h___
#define nsHTMLParts_h___

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* struct containing the output from nsIFrame::Reflow */
#ifndef nsHTMLReflowMetrics_h___
#define nsHTMLReflowMetrics_h___

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* struct containing the input to nsIFrame::Reflow */
#include "nsCOMPtr.h"
#include "nsStyleConsts.h"
#include "nsCSSAnonBoxes.h"

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* struct containing the input to nsIFrame::Reflow */
#ifndef nsHTMLReflowState_h___
#define nsHTMLReflowState_h___

View File

@ -35,6 +35,10 @@
*
* ***** END LICENSE BLOCK ***** */
/*
* interface for rendering objects that manually create subtrees of
* anonymous content
*/
#ifndef nsIAnonymousContentCreator_h___
#define nsIAnonymousContentCreator_h___

View File

@ -35,6 +35,8 @@
*
* ***** END LICENSE BLOCK ***** */
/* interface to rendering object that lives inside the document scrollbars */
#ifndef nsICanvasFrame_h__
#define nsICanvasFrame_h__

View File

@ -35,6 +35,8 @@
*
* ***** END LICENSE BLOCK ***** */
/* interface for all rendering objects */
#ifndef nsIFrame_h___
#define nsIFrame_h___

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* debugging interface for all rendering objects */
#ifndef nsIFrameDebug_h___
#define nsIFrameDebug_h___

View File

@ -34,6 +34,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* interface for rendering objects for replaced elements containing a
* document, such as <frame>, <iframe>, and some <object>s
*/
#ifndef nsIFrameFrame_h___
#define nsIFrameFrame_h___

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* utilities for regression tests based on frame tree comparison */
#ifndef nsIFrameUtil_h___
#define nsIFrameUtil_h___

View File

@ -34,6 +34,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* interface for rendering objects for replaced elements with bitmap
* image data
*/
#ifndef nsIImageFrame_h___
#define nsIImageFrame_h___

View File

@ -34,6 +34,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* interface for rendering objects for replaced elements implemented by
* a plugin
*/
#ifndef nsIObjectFrame_h___
#define nsIObjectFrame_h___

View File

@ -35,6 +35,11 @@
*
* ***** END LICENSE BLOCK ***** */
/*
* interface for rendering objects that wrap rendering objects that should
* be scrollable
*/
#ifndef nsIScrollFrame_h___
#define nsIScrollFrame_h___

View File

@ -1,3 +1,8 @@
/*
* interface for rendering objects whose state is saved in
* session-history (back-forward navigation)
*/
#ifndef _nsIStatefulFrame_h
#define _nsIStatefulFrame_h

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering object for replaced elements with bitmap image data */
#include "nsHTMLParts.h"
#include "nsCOMPtr.h"
#include "nsImageFrame.h"

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering object for replaced elements with bitmap image data */
#ifndef nsImageFrame_h___
#define nsImageFrame_h___

View File

@ -35,6 +35,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* code for HTML client-side image maps */
#include "nsImageMap.h"
#include "nsString.h"
#include "nsReadableUtils.h"

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* code for HTML client-side image maps */
#ifndef nsImageMap_h___
#define nsImageMap_h___

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering object for CSS display:inline objects */
#include "nsCOMPtr.h"
#include "nsInlineFrame.h"
#include "nsBlockFrame.h"

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering object for CSS display:inline objects */
#ifndef nsInlineFrame_h___
#define nsInlineFrame_h___

View File

@ -36,6 +36,8 @@
*
* ***** END LICENSE BLOCK ***** */
/* a set of ranges on a number-line */
#include "nsIntervalSet.h"
#include NEW_H

View File

@ -36,6 +36,8 @@
*
* ***** END LICENSE BLOCK ***** */
/* a set of ranges on a number-line */
#ifndef nsIntervalSet_h___
#define nsIntervalSet_h___

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* base class for rendering objects that do not have child lists */
#include "nsCOMPtr.h"
#include "nsLeafFrame.h"
#include "nsHTMLContainerFrame.h"

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* base class for rendering objects that do not have child lists */
#ifndef nsLeafFrame_h___
#define nsLeafFrame_h___

View File

@ -37,6 +37,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* representation of one line within a block frame, a CSS line box */
#include "nsLineBox.h"
#include "nsSpaceManager.h"
#include "nsLineLayout.h"

View File

@ -36,6 +36,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* representation of one line within a block frame, a CSS line box */
#ifndef nsLineBox_h___
#define nsLineBox_h___

View File

@ -40,6 +40,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* state and methods used while laying out a single line of a block frame */
#define PL_ARENA_CONST_ALIGN_MASK (sizeof(void*)-1)
#include "plarena.h"

View File

@ -44,6 +44,9 @@
* Date Modified by Description of modification
* 04/20/2000 IBM Corp. OS/2 VisualAge build.
*/
/* state and methods used while laying out a single line of a block frame */
#ifndef nsLineLayout_h___
#define nsLineLayout_h___

View File

@ -41,6 +41,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering objects for replaced elements implemented by a plugin */
#include "nscore.h"
#include "nsCOMPtr.h"
#include "nsPresContext.h"

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering objects for replaced elements implemented by a plugin */
#ifndef nsObjectFrame_h___
#define nsObjectFrame_h___

View File

@ -34,6 +34,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* rendering object for the point that anchors out-of-flow rendering
* objects such as floats and absolutely positioned elements
*/
#include "nsPlaceholderFrame.h"
#include "nsLineLayout.h"
#include "nsIContent.h"

View File

@ -34,6 +34,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* rendering object for the point that anchors out-of-flow rendering
* objects such as floats and absolutely positioned elements
*/
#ifndef nsPlaceholderFrame_h___
#define nsPlaceholderFrame_h___

View File

@ -35,6 +35,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* class that manages regions of 2-D space, originally designed
* generally but actually specific to space occupied by floats
*/
#include "nsSpaceManager.h"
#include "nsPoint.h"
#include "nsRect.h"

View File

@ -35,6 +35,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* class that manages regions of 2-D space, originally designed
* generally but actually specific to space occupied by floats
*/
#ifndef nsSpaceManager_h___
#define nsSpaceManager_h___

View File

@ -34,6 +34,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering object for HTML <spacer> element */
#include "nsHTMLParts.h"
#include "nsFrame.h"
#include "nsLineLayout.h"

View File

@ -34,6 +34,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* base class for rendering objects that can be split across lines,
* columns, or pages
*/
#include "nsSplittableFrame.h"
#include "nsIContent.h"
#include "nsPresContext.h"

View File

@ -34,6 +34,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* base class for rendering objects that can be split across lines,
* columns, or pages
*/
#ifndef nsSplittableFrame_h___
#define nsSplittableFrame_h___

View File

@ -45,6 +45,9 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* rendering object for textual content of elements */
#include "nsCOMPtr.h"
#include "nsHTMLParts.h"
#include "nsCRT.h"

View File

@ -35,6 +35,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* class for transformation of text before rendering, including CSS
* text-transform
*/
#include <ctype.h>
#include "nsCOMPtr.h"
#include "nsTextTransformer.h"

View File

@ -34,6 +34,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* class for transformation of text before rendering, including CSS
* text-transform
*/
#ifndef nsTextTransformer_h___
#define nsTextTransformer_h___

View File

@ -34,6 +34,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* rendering object that is the root of the frame tree, which contains
* the document's scrollbars and contains fixed-positioned elements
*/
#include "nsCOMPtr.h"
#include "nsViewportFrame.h"
#include "nsHTMLParts.h"

View File

@ -34,6 +34,12 @@
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* rendering object that is the root of the frame tree, which contains
* the document's scrollbars and contains fixed-positioned elements
*/
#ifndef nsViewportFrame_h___
#define nsViewportFrame_h___