Bug 734656 - Add documenting comments to some SVG frame classes. r=longsonr.

--HG--
extra : rebase_source : 0663c60ccaa1a89041d47d3db109f1de2a2b9f92
This commit is contained in:
Jonathan Watt 2012-03-10 19:28:24 +00:00
parent 59b4bbc1cf
commit 2370d31893
2 changed files with 18 additions and 0 deletions

View File

@ -57,6 +57,13 @@ class SVGLengthList;
class SVGUserUnitList;
}
/**
* This class is not particularly well named. It is inherited by some, but
* not all SVG frame classes that can be descendants of an
* nsSVGOuterSVGFrame in the frame tree. Note specifically that SVG container
* frames that do not inherit nsSVGDisplayContainerFrame do not inherit this
* class (so that's classes that only inherit nsSVGContainerFrame).
*/
class nsISVGChildFrame : public nsQueryFrame
{
public:

View File

@ -47,6 +47,13 @@ class nsRenderingContext;
typedef nsContainerFrame nsSVGContainerFrameBase;
/**
* Base class for SVG container frames. Frame sub-classes that do not
* display their contents directly (such as the frames for <marker> or
* <pattern>) just inherit this class. Frame sub-classes that do or can
* display their contents directly (such as the frames for inner-<svg> or
* <g>) inherit our nsDisplayContainerFrame sub-class.
*/
class nsSVGContainerFrame : public nsSVGContainerFrameBase
{
friend nsIFrame* NS_NewSVGContainerFrame(nsIPresShell* aPresShell,
@ -79,6 +86,10 @@ public:
}
};
/**
* Frame class or base-class for SVG containers that can or do display their
* contents directly.
*/
class nsSVGDisplayContainerFrame : public nsSVGContainerFrame,
public nsISVGChildFrame
{